$darkmode
Qore FileLocationHandler Module Reference 2.3
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 
26 namespace FileLocationHandler {
28 
31 
32 public:
33 
35 
41 protected:
42  string getTextFileImpl(string scheme, string location, *hash<auto> opts);
43 public:
44 
45 
47 
53 protected:
54  binary getBinaryFileImpl(string scheme, string location, *hash<auto> opts);
55 public:
56 
57 
59 
65 protected:
66  Qore::AbstractPollOperation getIoPollerForLocationImpl(string scheme, string location, *hash<auto> opts);
67 public:
68 
69 
71 
77 protected:
78  Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash<auto> opts);
79 public:
80 
81 
83 
89 protected:
90  Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash<auto> opts);
91 public:
92 
93 
95 
102 protected:
103  writeFileImpl(string scheme, string location, data contents, *hash<auto> opts);
104 public:
105 
106 
108 
114 protected:
115  OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash<auto> opts);
116 public:
117 
118 
120 
122 protected:
123  hash<string, hash<FileHandlerOptionInfo>> getReadOptionsImpl();
124 public:
125 
126 
128 
130 protected:
131  hash<string, hash<FileHandlerOptionInfo>> getWriteOptionsImpl();
132 public:
133 
134 };
135 
137 class ImmediateDataPollOperation : public AbstractPollOperation {
138 
139 public:
140 protected:
142  auto value;
143 
144 public:
145 
148 
149 
151  string getGoal();
152 
153 
155  string getState();
156 
157 
159  bool goalReached();
160 
161 
163  *hash<SocketPollInfo> continuePoll();
164 
165 
167  auto getOutput();
168 
169 };
170 };
The abstract file location handler class.
Definition: FileLocationHandler.qc.dox.h:53
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.
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.
Qore::AbstractPollOperation getIoPollerForLocationImpl(string scheme, string location, *hash< auto > opts)
Retrieves an I/O poller to retrieve a binary file from the given location.
hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl()
Gets supported read options.
This class allows immediate data to be returned for a polling operation.
Definition: FileLocationHandlerData.qc.dox.h:137
string getGoal()
The goal is always "done".
auto value
The value to return.
Definition: FileLocationHandlerData.qc.dox.h:142
*hash< SocketPollInfo > continuePoll()
Always returns NOTHING.
constructor(auto value)
Creates the object with the value to be returned.
string getState()
The state is always "done".
The abstract file location handler class.
Definition: OutputStramWrapper.qc.dox.h:28
binary binary()
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:26