The class for handling "data://" locations. More...

#include <FileLocationHandlerData.qc.dox.h>

Inheritance diagram for FileLocationHandler::FileLocationHandlerData:

Private Member Methods
binary	getBinaryFileImpl (string scheme, string location, *hash< auto > opts)
	Retrieves a binary file from the given location. More...

Qore::InputStream	getBinaryStreamImpl (string scheme, string location, *hash< auto > opts)
	Retrieves a binary file from the given location. More...

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...

OutputStreamWrapper	getOutputStreamImpl (string scheme, string location, *hash< auto > opts)
	Not supported for data:// locations; throws an exception. More...

hash< string, hash< FileHandlerOptionInfo > >	getReadOptionsImpl ()
	Gets supported read options. More...

Qore::StreamReader	getStreamReaderImpl (string scheme, string location, *hash< auto > opts)
	Returns a stream reader for the file's data at the given location. More...

string	getTextFileImpl (string scheme, string location, *hash< auto > opts)
	Retrieves a text file from the given location. More...

hash< string, hash< FileHandlerOptionInfo > >	getWriteOptionsImpl ()
	Gets supported write options. More...

	writeFileImpl (string scheme, string location, data contents, *hash< auto > opts)
	Not supported for data:// locations; throws an exception. More...

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...

Additional Inherited Members
Public Member Methods inherited from FileLocationHandler::AbstractFileLocationHandler
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...

Static Private Member Methods inherited from FileLocationHandler::AbstractFileLocationHandler
static string	forceEncoding (string str, *string encoding)
	Returns a string tagged with the given encoding, if any.

Detailed Description

The class for handling "data://" locations.

This location can be used for reading immediate data; data:// locations cannot be written to

Member Function Documentation

◆ getBinaryFileImpl()

binary FileLocationHandler::FileLocationHandlerData::getBinaryFileImpl	(	string	scheme,
		string	location,
		*hash< auto >	opts
	)

privatevirtual

Retrieves a binary file from the given location.

Parameters

scheme	the scheme being used
location	the location string without the scheme
opts	read options

Returns: the location string without the scheme converted to binary data

Implements FileLocationHandler::AbstractFileLocationHandler.

◆ getBinaryStreamImpl()

Qore::InputStream FileLocationHandler::FileLocationHandlerData::getBinaryStreamImpl	(	string	scheme,
		string	location,
		*hash< auto >	opts
	)

privatevirtual

Retrieves a binary file from the given location.

Parameters

scheme	the scheme being used
location	the location string without the scheme
opts	read options

Returns: an input stream of the file's contents, if it can be retrieved

Implements FileLocationHandler::AbstractFileLocationHandler.

◆ getIoPollerForLocationImpl()

Qore::AbstractPollOperation FileLocationHandler::FileLocationHandlerData::getIoPollerForLocationImpl	(	string	scheme,
		string	location,
		*hash< auto >	opts
	)

privatevirtual

Retrieves an I/O poller to retrieve a binary file from the given location.

Parameters

scheme	the scheme being used
location	the location string without the scheme
opts	read options

Returns: an I/O poller to retrieve the file's data

Implements FileLocationHandler::AbstractFileLocationHandler.

◆ getOutputStreamImpl()

OutputStreamWrapper FileLocationHandler::FileLocationHandlerData::getOutputStreamImpl	(	string	scheme,
		string	location,
		*hash< auto >	opts
	)

privatevirtual

Not supported for data:// locations; throws an exception.

Parameters

scheme	the scheme being used
location	the location string without the scheme
opts	write options

Exceptions

DATA-WRITE-ERROR cannot write to data:// locations

Implements FileLocationHandler::AbstractFileLocationHandler.

◆ getReadOptionsImpl()

hash< string, hash< FileHandlerOptionInfo > > FileLocationHandler::FileLocationHandlerData::getReadOptionsImpl ( )

privatevirtual

Gets supported read options.

Returns: supported read options

Implements FileLocationHandler::AbstractFileLocationHandler.

◆ getStreamReaderImpl()

Qore::StreamReader FileLocationHandler::FileLocationHandlerData::getStreamReaderImpl	(	string	scheme,
		string	location,
		*hash< auto >	opts
	)

privatevirtual

Returns a stream reader for the file's data at the given location.

Parameters

scheme	the scheme being used
location	the location string without the scheme
opts	read options

Returns: a stream reader for the location string without the scheme

Implements FileLocationHandler::AbstractFileLocationHandler.

◆ getTextFileImpl()

string FileLocationHandler::FileLocationHandlerData::getTextFileImpl	(	string	scheme,
		string	location,
		*hash< auto >	opts
	)

privatevirtual

Retrieves a text file from the given location.

Parameters

scheme	the scheme being used
location	the location string without the scheme
opts	read options

Returns: the location string without the scheme

Implements FileLocationHandler::AbstractFileLocationHandler.

◆ getWriteOptionsImpl()

hash< string, hash< FileHandlerOptionInfo > > FileLocationHandler::FileLocationHandlerData::getWriteOptionsImpl ( )

privatevirtual

Gets supported write options.

Returns: supported write options

Implements FileLocationHandler::AbstractFileLocationHandler.

◆ writeFileImpl()

FileLocationHandler::FileLocationHandlerData::writeFileImpl	(	string	scheme,
		string	location,
		data	contents,
		*hash< auto >	opts
	)

privatevirtual

Not supported for data:// locations; throws an exception.

Parameters

scheme	the scheme being used
location	the location string without the scheme
contents	the file's contents
opts	write options

Exceptions

DATA-WRITE-ERROR cannot write to data:// locations

Implements FileLocationHandler::AbstractFileLocationHandler.

Private Member Methods

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getBinaryFileImpl()

◆ getBinaryStreamImpl()

◆ getIoPollerForLocationImpl()

◆ getOutputStreamImpl()

◆ getReadOptionsImpl()

◆ getStreamReaderImpl()

◆ getTextFileImpl()

◆ getWriteOptionsImpl()

◆ writeFileImpl()