Qore FileLocationHandler Module Reference 2.3
Loading...
Searching...
No Matches
FileLocationHandlerFile.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* FileLocationHandlerFile Copyright 2021 - 2024 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 {
29
30public:
32
34 const FileLocationOpts = ...;
35
36
38
41
42
44
47
48
50
60protected:
61 string getTextFileImpl(string scheme, string location, *hash<auto> opts);
62public:
63
64
66
76protected:
77 binary getBinaryFileImpl(string scheme, string location, *hash<auto> opts);
78public:
79
80
82
88protected:
89 Qore::AbstractPollOperation getIoPollerForLocationImpl(string scheme, string location, *hash<auto> opts);
90public:
91
92
94
102protected:
103 Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash<auto> opts);
104public:
105
106
108
116protected:
117 Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash<auto> opts);
118public:
119
120
122
129protected:
130 writeFileImpl(string scheme, string location, data contents, *hash<auto> opts);
131public:
132
133
135
146protected:
147 OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash<auto> opts);
148public:
149
150
152
154protected:
155 hash<string, hash<FileHandlerOptionInfo>> getReadOptionsImpl();
156public:
157
158
160
162protected:
163 hash<string, hash<FileHandlerOptionInfo>> getWriteOptionsImpl();
164public:
165
166};
167};
The abstract file location handler class.
Definition FileLocationHandler.qc.dox.h:53
The class for handling "file://" locations.
Definition FileLocationHandlerFile.qc.dox.h:28
const FileLocationWriteOpts
Valid file location write options.
Definition FileLocationHandlerFile.qc.dox.h:46
hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl()
Gets supported write options.
Qore::AbstractPollOperation getIoPollerForLocationImpl(string scheme, string location, *hash< auto > opts)
Retrieves an I/O poller to retrieve a binary file from the given location.
const FileLocationReadOpts
Valid common file location options.
Definition FileLocationHandlerFile.qc.dox.h:40
hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl()
Gets supported read options.
Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash< auto > opts)
Returns a stream reader for the file's data at the given location.
binary getBinaryFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
const FileLocationOpts
Valid common file location options.
Definition FileLocationHandlerFile.qc.dox.h:34
string getTextFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a text file from the given location.
Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash< auto > opts)
Returns an output stream for writing data to the given location.
writeFileImpl(string scheme, string location, data contents, *hash< auto > opts)
Writes data to a file at the given location.
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