| Qore Programming Language Reference Manual 1.0.8

QC_ReadOnlyFile.dox.h
1
3 namespace Qore {
5
19 class ReadOnlyFile {
20
21 public:
23
36 int close();
37
38 public:
40
57 constructor(string path, *string encoding);
58
59 public:
61
66 copy();
67
68 public:
70
72 destructor();
73
74 public:
76
86 string getEncoding();
87
88 public:
90
102 *string getFileName();
103
104 public:
106
120 int getPos();
121
122 public:
124
137 *string getchar();
138
139 public:
141
157 hash<StatInfo> hstat();
158
159 public:
161
178 bool isDataAvailable(timeout timeout_ms = 0);
179
180 public:
182
192 bool isOpen();
193
194 public:
196
208 bool isTty();
209
210 public:
212
237 nothing open(string path, *string encoding);
238
239 public:
241
269 *string read(softint size, timeout timeout_ms = -1);
270
271 public:
273
300 *binary readBinary(softint size, timeout timeout_ms = -1);
301
302 public:
304
329 *string readLine(bool incl_eol = True, *string eol);
330
331 public:
333
346 *int readi1();
347
348 public:
350
363 *int readi2();
364
365 public:
367
380 *int readi2LSB();
381
382 public:
384
397 *int readi4();
398
399 public:
401
414 *int readi4LSB();
415
416 public:
418
431 *int readi8();
432
433 public:
435
448 *int readi8LSB();
449
450 public:
452
465 *int readu1();
466
467 public:
469
482 *int readu2();
483
484 public:
486
499 *int readu2LSB();
500
501 public:
503
516 *int readu4();
517
518 public:
520
533 *int readu4LSB();
534
535 public:
537
546 nothing setEncoding(*string encoding);
547
548 public:
550
566 nothing setEventQueue(Queue queue, auto arg, *bool with_data);
567
568 public:
570
579 nothing setEventQueue();
580
581 public:
583
596 int setPos(int pos = 0);
597
598 public:
600
616 list<auto> stat();
617
618 public:
620
636 hash<FilesystemInfo> statvfs();
637
638 public:
640
662 static hash<StatInfo> hlstat(string path);
663
664 public:
666
687 static hash<StatInfo> hstat(string path);
688
689 public:
691
713 static list<auto> lstat(string path);
714
715 public:
717
739 static binary readBinaryFile(string path, int max_file_len = -1);
740
741 public:
743
768 static string readTextFile(string path, *string encoding, int max_file_len = -1);
769
770 public:
772
793 static list<auto> stat(string path);
794
795 public:
797
819 static hash<FilesystemInfo> statvfs(string path);
820 };
824
826 const S_IFBLK = S_IFBLK;
829 const S_IFCHR = S_IFCHR;
831 const S_IFDIR = S_IFDIR;
833 const S_IFLNK = S_IFLNK;
835 const S_IFMT = S_IFMT;
837 const S_IFREG = S_IFREG;
839 const S_IFSOCK = S_IFSOCK;
841 const S_IFWHT = S_IFWHT;
843 const S_IRGRP = S_IRGRP;
845 const S_IROTH = S_IROTH;
847 const S_IRUSR = S_IRUSR;
849 const S_IRWXG = S_IRWXG;
851 const S_IRWXO = S_IRWXO;
853 const S_IRWXU = S_IRWXU;
855 const S_ISGID = S_ISGID;
857 const S_ISUID = S_ISUID;
859 const S_ISVTX = S_ISVTX;
861 const S_IWGRP = S_IWGRP;
863 const S_IWOTH = S_IWOTH;
865 const S_IWUSR = S_IWUSR;
867 const S_IXGRP = S_IXGRP;
869 const S_IXOTH = S_IXOTH;
871 const S_IXUSR = S_IXUSR;
873 }
Qore::ReadOnlyFile::constructor
constructor(string path, *string encoding)
Creates the ReadOnlyFile object.
Qore::ReadOnlyFile::readu4
*int readu4()
Reads a 4-byte (32 bit) unsigned integer from the file in big-endian format or NOTHING if no data can...
Qore::S_IFREG
const S_IFREG
Bit signifying if the file is a regular file.
Definition: QC_ReadOnlyFile.dox.h:837
Qore::ReadOnlyFile::readi4
*int readi4()
Reads a 4-byte (32 bit) signed integer from the file in binary big-endian format or NOTHING if no dat...
Qore::S_IRWXO
const S_IRWXO
Bitmask giving the RWX mask for other; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:851
Qore::S_IFDIR
const S_IFDIR
Bit signifying if the entry is a directory.
Definition: QC_ReadOnlyFile.dox.h:831
Qore::S_IRWXU
const S_IRWXU
Bitmask giving the RWX mask for the owner.
Definition: QC_ReadOnlyFile.dox.h:853
Qore::ReadOnlyFile::hlstat
static hash< StatInfo > hlstat(string path)
Returns a StatInfo hash about the file&#39;s status (does not follow symbolic links) or throws an excepti...
Qore::ReadOnlyFile::readBinaryFile
static binary readBinaryFile(string path, int max_file_len=-1)
returns the contents of a binary file as a binary object
Qore::ReadOnlyFile::readu2LSB
*int readu2LSB()
Reads a 2-byte (16 bit) unsigned integer from the file in binary little-endian format or NOTHING if n...
Qore::ReadOnlyFile::setPos
int setPos(int pos=0)
Sets the current file position (in bytes from the beginning of the file)
Qore::S_IFWHT
const S_IFWHT
Bitmask signifying if the file is a whiteout file; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:841
Qore::True
const True
logical True
Definition: qc_qore.dox.h:98
Qore::ReadOnlyFile::copy
copy()
Creates a new ReadOnlyFile object with the same character encoding specification as the original...
Qore::ReadOnlyFile::open
nothing open(string path, *string encoding)
Opens a file in a particular mode; throws an exception on failure.
Qore::ReadOnlyFile::getEncoding
string getEncoding()
Returns the character encoding for the ReadOnlyFile.
Qore::S_IXUSR
const S_IXUSR
Bit signifying if the file&#39;s owner has execute permissions.
Definition: QC_ReadOnlyFile.dox.h:871
Qore::binary
binary binary()
Always returns an empty binary object (of zero length)
Qore::ReadOnlyFile::isOpen
bool isOpen()
returns True if the File is open, False if not
Qore::S_IWUSR
const S_IWUSR
Bit signifying if the file&#39;s owner has write permissions.
Definition: QC_ReadOnlyFile.dox.h:865
Qore::ReadOnlyFile::lstat
static list< auto > lstat(string path)
Returns a Stat List about the given path&#39;s status (does not follow symbolic links) or throws an excep...
Qore::ReadOnlyFile::read
*string read(softint size, timeout timeout_ms=-1)
Reads a certain number of characters from the ReadOnlyFile within an optional timeout period and retu...
Qore::ReadOnlyFile::getFileName
*string getFileName()
returns the file path/name used to open the file if the file is open, otherwise NOTHING ...
Qore::ReadOnlyFile::close
int close()
Closes the ReadOnlyFile object.
Qore::ReadOnlyFile::getchar
*string getchar()
Reads one character from the file and returns it as a string; returns NOTHING if no data can be read ...
Qore::S_IRGRP
const S_IRGRP
Bit signifying if the file&#39;s group has read permissions; equal to 0 on native Windows ports...
Definition: QC_ReadOnlyFile.dox.h:843
Qore::ReadOnlyFile::readLine
*string readLine(bool incl_eol=True, *string eol)
Reads until an EOL marker is found and returns the string read or NOTHING if no data can be read...
Qore::ReadOnlyFile::getPos
int getPos()
Returns the current file position as an integer giving the offset in bytes from the beginning of the ...
Qore::ReadOnlyFile::destructor
destructor()
Closes the ReadOnlyFile if it is open and destroys the ReadOnlyFile object.
Qore::ReadOnlyFile::readi1
*int readi1()
Reads a 1-byte signed integer from the file in binary format or NOTHING if no data can be read...
Qore::ReadOnlyFile::statvfs
hash< FilesystemInfo > statvfs()
Returns a FilesystemInfo hash about the file&#39;s filesystem status or throws an exception if any errors...
Qore::S_IFCHR
const S_IFCHR
Bit signifying if the file is a character special (device) file.
Definition: QC_ReadOnlyFile.dox.h:829
Qore::ReadOnlyFile::readi2LSB
*int readi2LSB()
Reads a 2-byte (16 bit) signed integer from the file in binary little-endian format or NOTHING if no ...
Qore::ReadOnlyFile::readi8
*int readi8()
Reads an 8-byte (64 bit) signed integer from the file in binary big-endian format or NOTHING if no da...
Qore::ReadOnlyFile::stat
list< auto > stat()
Returns a Stat List about the file&#39;s status or throws an exception if any errors occur.
Qore::S_IROTH
const S_IROTH
Bit signifying if other has read permissions; equal to 0 on native Windows ports. ...
Definition: QC_ReadOnlyFile.dox.h:845
Qore::ReadOnlyFile::readi4LSB
*int readi4LSB()
Reads a 4-byte (32 bit) signed integer from the file in binary little-endian format or NOTHING if no ...
Qore::ReadOnlyFile::isDataAvailable
bool isDataAvailable(timeout timeout_ms=0)
Returns True if there is data available for reading from the file within the timeout period...
Qore::ReadOnlyFile::hstat
hash< StatInfo > hstat()
Returns a StatInfo hash about the file&#39;s status or throws an exception if any errors occur...
Qore::S_IWOTH
const S_IWOTH
Bit signifying if other has write permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:863
Qore::S_IXGRP
const S_IXGRP
Bit signifying if the file&#39;s group has execute permissions; equal to 0 on native Windows ports...
Definition: QC_ReadOnlyFile.dox.h:867
Qore::ReadOnlyFile::readTextFile
static string readTextFile(string path, *string encoding, int max_file_len=-1)
returns the contents of a text file as a string optionally tagged with the given character encoding ...
Qore::S_ISUID
const S_ISUID
Bit signifying set user id on execution; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:857
Qore::S_IFLNK
const S_IFLNK
Bitmask signifying if the file is a symbolic link; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:833
Qore::S_ISVTX
const S_ISVTX
Bit signifying restricted deletes for directories; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:859
Qore::S_IWGRP
const S_IWGRP
Bit signifying if the file&#39;s group has write permissions; equal to 0 on native Windows ports...
Definition: QC_ReadOnlyFile.dox.h:861
Qore::S_IFMT
const S_IFMT
File type bitmask
Definition: QC_ReadOnlyFile.dox.h:835
Qore::ReadOnlyFile::readu4LSB
*int readu4LSB()
Reads a 4-byte (32 bit) unsigned integer from the file in binary little-endian format or NOTHING if n...
Qore::ReadOnlyFile::readi2
*int readi2()
Reads a 2-byte (16 bit) signed integer from the file in binary big-endian format or NOTHING if no dat...
Qore::S_IFBLK
const S_IFBLK
Bitmask signifying if the file is a block special (device) file.
Definition: QC_ReadOnlyFile.dox.h:827
Qore::ReadOnlyFile::setEventQueue
nothing setEventQueue()
Removes any Queue object from the ReadOnlyFile object so that file events are no longer added to the ...
Qore::ReadOnlyFile::setEncoding
nothing setEncoding(*string encoding)
Sets the character encoding for the ReadOnlyFile; if called with no argument, the default encoding is...
Qore::S_ISGID
const S_ISGID
Bit signifying set group id on execution; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:855
Qore::ReadOnlyFile::isTty
bool isTty()
returns True if the File is connected to a terminal device, False if not
Qore::ReadOnlyFile::readBinary
*binary readBinary(softint size, timeout timeout_ms=-1)
Reads a certain number of bytes from the file within an optional timeout period and returns a binary ...
Qore
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
Qore::S_IRWXG
const S_IRWXG
Bitmask giving the RWX mask for the group; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:849
Qore::S_IFSOCK
const S_IFSOCK
Bitmask signifying if the file is a socket file; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:839
Qore::ReadOnlyFile
The ReadOnlyFile class allows Qore programs to read existing files.
Definition: QC_ReadOnlyFile.dox.h:19
Qore::ReadOnlyFile::readu1
*int readu1()
Reads a 1-byte unsigned integer from the ReadOnlyFile in binary format or NOTHING if no data can be r...
Qore::ReadOnlyFile::readu2
*int readu2()
Reads a 2-byte (16 bit) unsigned integer from the ReadOnlyFile in binary big-endian format or NOTHING...
Qore::S_IRUSR
const S_IRUSR
Bit signifying if the file&#39;s owner has read permissions.
Definition: QC_ReadOnlyFile.dox.h:847
Qore::S_IXOTH
const S_IXOTH
Bit signifying if other has execute permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:869
Qore::ReadOnlyFile::readi8LSB
*int readi8LSB()
Reads an 8-byte (64 bit) signed integer from the file in binary little-endian format or NOTHING if no...