FileLocationHandlerFile.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
/* FileLocationHandlerFile Copyright 2020 Qore Technologies, s.r.o.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
// minimum required Qore version
// assume local scope for variables, do not use "$" signs
// require type definitions everywhere
// strict argument handling
// enable all warnings
namespace FileLocationHandler {
class FileLocationHandlerFile : public FileLocationHandler {
public:
const FileLocationOpts = ("encoding", "max_file_len");
const MaxFileLen = 10 * 1024 * 1024;
static data handler(string scheme, bool text, string location);
};
};
FileLocationHandler::FileLocationHandlerFile
The class for handling file locations.
Definition: FileLocationHandlerFile.qc.dox.h:35
FileLocationHandler::FileLocationHandlerFile::handler
static data handler(string scheme, bool text, string location)
Returns the file data from the given file location.
FileLocationHandler::FileLocationHandlerFile::FileLocationOpts
const FileLocationOpts
Valid file location options.
Definition: FileLocationHandlerFile.qc.dox.h:43
FileLocationHandler::FileLocationHandlerFile::MaxFileLen
const MaxFileLen
Default maximum file length to read (10 MB)
Definition: FileLocationHandlerFile.qc.dox.h:46
FileLocationHandler
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:32