Qore FileLocationHandler Module Reference 2.2
Loading...
Searching...
No Matches
FileLocationHandlerData.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* FileLocationHandlerData Copyright 2021 - 2023 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23*/
24
26namespace FileLocationHandler {
28
31
32public:
33
35
41protected:
42 string getTextFileImpl(string scheme, string location, *hash<auto> opts);
43public:
44
45
47
53protected:
54 binary getBinaryFileImpl(string scheme, string location, *hash<auto> opts);
55public:
56
57
59
65protected:
66 Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash<auto> opts);
67public:
68
69
71
77protected:
78 Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash<auto> opts);
79public:
80
81
83
90protected:
91 writeFileImpl(string scheme, string location, data contents, *hash<auto> opts);
92public:
93
94
96
102protected:
103 OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash<auto> opts);
104public:
105
106
108
110protected:
111 hash<string, hash<FileHandlerOptionInfo>> getReadOptionsImpl();
112public:
113
114
116
118protected:
119 hash<string, hash<FileHandlerOptionInfo>> getWriteOptionsImpl();
120public:
121
122};
123};
The abstract file location handler class.
Definition: FileLocationHandler.qc.dox.h:43
The class for handling "data://" locations.
Definition: FileLocationHandlerData.qc.dox.h:30
binary getBinaryFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl()
Gets supported read options.
string getTextFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a text file from the given location.
writeFileImpl(string scheme, string location, data contents, *hash< auto > opts)
Not supported for data:// locations; throws an exception.
Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash< auto > opts)
Returns a stream reader for the file's data at the given location.
OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash< auto > opts)
Not supported for data:// locations; throws an exception.
Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl()
Gets supported write options.
The abstract file location handler class.
Definition: OutputStramWrapper.qc.dox.h:28
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:26