$darkmode
The abstract file location handler class. More...
Public Member Functions | |
| binary | getBinaryFile (string scheme, string location, *hash< auto > opts) |
| Retrieves a binary file from the given location. More... | |
| Qore::InputStream | getBinaryStream (string scheme, string location, *hash< auto > opts) |
| Retrieves a binary file from the given location. More... | |
| Qore::AbstractPollOperation | getIoPollerForLocation (string scheme, string location, *hash< auto > opts) |
| Retrieves an I/O poller to retrieve a binary file from the given location. More... | |
| OutputStreamWrapper | getOutputStream (string scheme, string location, *hash< auto > opts) |
| Returns an output stream for writing data to the given location. More... | |
| hash< string, hash< FileHandlerOptionInfo > > | getReadOptions () |
| Gets supported read options. More... | |
| Qore::StreamReader | getStreamReader (string scheme, string location, *hash< auto > opts) |
| Returns a string stream for the file's data at the given location. More... | |
| string | getTextFile (string scheme, string location, *hash< auto > opts) |
| Retrieves a text file from the given location. More... | |
| hash< string, hash< FileHandlerOptionInfo > > | getWriteOptions () |
| Gets supported write options. More... | |
| writeFile (string scheme, string location, data contents, *hash< auto > opts) | |
| Writes data to a file at the given location. More... | |
Protected Member Functions | |
| abstract binary | getBinaryFileImpl (string scheme, string location, *hash< auto > opts) |
| Retrieves a binary file from the given location. More... | |
| abstract Qore::InputStream | getBinaryStreamImpl (string scheme, string location, *hash< auto > opts) |
| Retrieves a binary file from the given location. More... | |
| abstract Qore::AbstractPollOperation | getIoPollerForLocationImpl (string scheme, string location, *hash< auto > opts) |
| Retrieves an I/O poller to retrieve a binary file from the given location. More... | |
| abstract OutputStreamWrapper | getOutputStreamImpl (string scheme, string location, *hash< auto > opts) |
| Returns an output stream for writing data to the given location. More... | |
| abstract hash< string, hash< FileHandlerOptionInfo > > | getReadOptionsImpl () |
| Gets supported read options. More... | |
| abstract Qore::StreamReader | getStreamReaderImpl (string scheme, string location, *hash< auto > opts) |
| Returns a string stream for the file's data at the given location. More... | |
| abstract string | getTextFileImpl (string scheme, string location, *hash< auto > opts) |
| Retrieves a text file from the given location. More... | |
| abstract hash< string, hash< FileHandlerOptionInfo > > | getWriteOptionsImpl () |
| Gets supported write options. More... | |
| abstract | writeFileImpl (string scheme, string location, data contents, *hash< auto > opts) |
| Writes data to a file at the given location. More... | |
Static Protected Member Functions | |
| static string | forceEncoding (string str, *string encoding) |
| Returns a string tagged with the given encoding, if any. | |
The abstract file location handler class.
| binary FileLocationHandler::AbstractFileLocationHandler::getBinaryFile | ( | string | scheme, |
| string | location, | ||
| *hash< auto > | opts | ||
| ) |
Retrieves a binary file from the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | read options |
|
protectedpure virtual |
Retrieves a binary file from the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | read options |
Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerRest, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, FileLocationHandler::FileLocationHandlerFile, and FileLocationHandler::FileLocationHandlerData.
| Qore::InputStream FileLocationHandler::AbstractFileLocationHandler::getBinaryStream | ( | string | scheme, |
| string | location, | ||
| *hash< auto > | opts | ||
| ) |
Retrieves a binary file from the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | read options |
|
protectedpure virtual |
Retrieves a binary file from the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | read options |
Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerRest, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, FileLocationHandler::FileLocationHandlerFile, and FileLocationHandler::FileLocationHandlerData.
| Qore::AbstractPollOperation FileLocationHandler::AbstractFileLocationHandler::getIoPollerForLocation | ( | string | scheme, |
| string | location, | ||
| *hash< auto > | opts | ||
| ) |
Retrieves an I/O poller to retrieve a binary file from the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | read options |
|
protectedpure virtual |
Retrieves an I/O poller to retrieve a binary file from the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | read options |
Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerRest, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, FileLocationHandler::FileLocationHandlerFile, and FileLocationHandler::FileLocationHandlerData.
| OutputStreamWrapper FileLocationHandler::AbstractFileLocationHandler::getOutputStream | ( | string | scheme, |
| string | location, | ||
| *hash< auto > | opts | ||
| ) |
Returns an output stream for writing data to the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | write options |
|
protectedpure virtual |
Returns an output stream for writing data to the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | write options |
Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerRest, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, FileLocationHandler::FileLocationHandlerFile, and FileLocationHandler::FileLocationHandlerData.
| hash<string, hash<FileHandlerOptionInfo> > FileLocationHandler::AbstractFileLocationHandler::getReadOptions | ( | ) |
Gets supported read options.
|
protectedpure virtual |
Gets supported read options.
Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerRest, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, FileLocationHandler::FileLocationHandlerFile, and FileLocationHandler::FileLocationHandlerData.
| Qore::StreamReader FileLocationHandler::AbstractFileLocationHandler::getStreamReader | ( | string | scheme, |
| string | location, | ||
| *hash< auto > | opts | ||
| ) |
Returns a string stream for the file's data at the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | read options |
|
protectedpure virtual |
Returns a string stream for the file's data at the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | read options |
Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerRest, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, FileLocationHandler::FileLocationHandlerFile, and FileLocationHandler::FileLocationHandlerData.
| string FileLocationHandler::AbstractFileLocationHandler::getTextFile | ( | string | scheme, |
| string | location, | ||
| *hash< auto > | opts | ||
| ) |
Retrieves a text file from the given location.
| scheme | the scheme being used |
| location | the location string without the scheme or options |
| opts | read options |
|
protectedpure virtual |
Retrieves a text file from the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| opts | read options |
Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerRest, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, FileLocationHandler::FileLocationHandlerFile, and FileLocationHandler::FileLocationHandlerData.
| hash<string, hash<FileHandlerOptionInfo> > FileLocationHandler::AbstractFileLocationHandler::getWriteOptions | ( | ) |
Gets supported write options.
|
protectedpure virtual |
Gets supported write options.
Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerRest, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, FileLocationHandler::FileLocationHandlerFile, and FileLocationHandler::FileLocationHandlerData.
| FileLocationHandler::AbstractFileLocationHandler::writeFile | ( | string | scheme, |
| string | location, | ||
| data | contents, | ||
| *hash< auto > | opts | ||
| ) |
Writes data to a file at the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| contents | the file's contents |
| opts | write options |
|
protectedpure virtual |
Writes data to a file at the given location.
| scheme | the scheme being used |
| location | the location string without the scheme |
| contents | the file's contents |
| opts | write options |
Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerRest, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, FileLocationHandler::FileLocationHandlerFile, and FileLocationHandler::FileLocationHandlerData.