| Qore FixedLengthUtil Module Reference 1.6

Loading...
Searching...
No Matches
FixedLengthFileIterator.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* FixedLengthFileIterator Copyright 2015 - 2024 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
25
27 namespace FixedLengthUtil {
29
68 class FixedLengthFileIterator : public FixedLengthUtil::FixedLengthAbstractIterator {
69
70 public:
71 protected:
73 string m_file_path;
74
75 public:
76
78
83 constructor(string path, hash<auto> spec, *hash<auto> opts) ;
84
85
87 string getEncoding();
88
89
91 string getFileName();
92
93
95 hash<Qore::StatInfo> hstat();
96
97
99 list<auto> stat();
100
101};
102};
FixedLengthUtil::FixedLengthAbstractIterator
Structured line iterator for abstract data allowing efficient "pipelined" processing.
Definition FixedLengthAbstractIterator.qc.dox.h:29
FixedLengthUtil::FixedLengthFileIterator
Structured line iterator for fixed-length line files allowing efficient "pipelined" processing.
Definition FixedLengthFileIterator.qc.dox.h:68
FixedLengthUtil::FixedLengthFileIterator::constructor
constructor(string path, hash< auto > spec, *hash< auto > opts)
Instantiates the FixedLengthFileIterator object.
FixedLengthUtil::FixedLengthFileIterator::getEncoding
string getEncoding()
Returns the character encoding for the file.
FixedLengthUtil::FixedLengthFileIterator::m_file_path
string m_file_path
the path of the file being iterated
Definition FixedLengthFileIterator.qc.dox.h:73
FixedLengthUtil::FixedLengthFileIterator::stat
list< auto > stat()
Returns a stat list of the underlying file.
FixedLengthUtil::FixedLengthFileIterator::getFileName
string getFileName()
Returns the file path/name used to open the file.
FixedLengthUtil::FixedLengthFileIterator::hstat
hash< Qore::StatInfo > hstat()
Returns a StatInfo hash of the underlying file.
FixedLengthUtil
The FixedLengthUtil namespace contains all the definitions in the FixedLengthUtil module.
Definition FixedLengthAbstractIterator.qc.dox.h:27