FixedLengthFileIterator.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
/* FixedLengthFileIterator Copyright 2015 - 2019 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.
*/
namespace FixedLengthUtil {
class FixedLengthFileIterator : public FixedLengthUtil::FixedLengthAbstractIterator {
public:
protected:
string m_file_path;
public:
constructor(string path, hash<auto> spec, *hash<auto> opts)
: FixedLengthAbstractIterator(new InputStreamLineIterator(new FileInputStream(path), opts.encoding, opts.eol), spec, opts);
string getEncoding();
string getFileName();
hash<Qore::StatInfo> hstat();
list<auto> stat();
};
};
FixedLengthUtil::FixedLengthFileIterator::stat
list< auto > stat()
Returns a stat list of the underlying file.
FixedLengthUtil::FixedLengthFileIterator::hstat
hash< Qore::StatInfo > hstat()
Returns a StatInfo hash of the underlying file.
FixedLengthUtil::FixedLengthFileIterator::getFileName
string getFileName()
Returns the file path/name used to open the file.
FixedLengthUtil::FixedLengthAbstractIterator
Structured line iterator for abstract data allowing efficient "pipelined" processing.
Definition: FixedLengthAbstractIterator.qc.dox.h:29
FixedLengthUtil
The FixedLengthUtil namespace contains all the definitions in the FixedLengthUtil module.
Definition: FixedLengthAbstractIterator.qc.dox.h:27
FixedLengthUtil::FixedLengthFileIterator
Structured line iterator for fixed-length line files allowing efficient "pipelined" processing.
Definition: FixedLengthFileIterator.qc.dox.h:68
FixedLengthUtil::FixedLengthAbstractIterator::constructor
constructor(AbstractLineIterator li, hash< auto > spec, *hash< auto > opts)
Instantiates the FixedLengthAbstractIterator object.
FixedLengthUtil::FixedLengthFileIterator::m_file_path
string m_file_path
the path of the file being iterated
Definition: FixedLengthFileIterator.qc.dox.h:73