Qore Programming Language Reference Manual 1.19.2
Loading...
Searching...
No Matches
QC_ReadOnlyFile.dox.h
1
3namespace Qore {
5
24
25public:
27
41int close();
42
43public:
45
68 constructor(string path, *string encoding);
69
70public:
72
78
79public:
81
84
85public:
87
97string getEncoding();
98
99public:
101
113*string getFileName();
114
115public:
117
131int getPos();
132
133public:
135
148*string getchar();
149
150public:
152
168hash<StatInfo> hstat();
169
170public:
172
189bool isDataAvailable(timeout timeout_ms = 0);
190
191public:
193
203bool isOpen();
204
205public:
207
219bool isTty();
220
221public:
223
255nothing open(string path, *string encoding);
256
257public:
259
300*string read(softint size, timeout timeout_ms = -1);
301
302public:
304
331*binary readBinary(softint size, timeout timeout_ms = -1);
332
333public:
335
360*string readLine(bool incl_eol = True, *string eol);
361
362public:
364
377*int readi1();
378
379public:
381
394*int readi2();
395
396public:
398
412
413public:
415
428*int readi4();
429
430public:
432
446
447public:
449
462*int readi8();
463
464public:
466
480
481public:
483
498*int readu1();
499
500public:
502
517*int readu2();
518
519public:
521
535
536public:
538
553*int readu4();
554
555public:
557
571
572public:
574
585nothing setEncoding(*string encoding);
586
587public:
589
605nothing setEventQueue(Queue queue, auto arg, *bool with_data);
606
607public:
609
619
620public:
622
635int setPos(int pos = 0);
636
637public:
639
657AbstractPollOperation startPollRead(string path, bool to_string = True, int to_read = -1);
658
659public:
661
677list<auto> stat();
678
679public:
681
697hash<FilesystemInfo> statvfs();
698
699public:
701
723static hash<StatInfo> hlstat(string path);
724
725public:
727
748static hash<StatInfo> hstat(string path);
749
750public:
752
774static list<auto> lstat(string path);
775
776public:
778
800static binary readBinaryFile(string path, int max_file_len = -1);
801
802public:
804
829static string readTextFile(string path, *string encoding, int max_file_len = -1);
830
831public:
833
854static list<auto> stat(string path);
855
856public:
858
880static hash<FilesystemInfo> statvfs(string path);
881};
888
898 const S_IFMT = S_IFMT;
936}
Abstract poll operation objects provide the polling interface for pollable objects.
Definition: QC_AbstractPollOperation.dox.h:6
Interface for builtin classes that support I/O polling.
Definition: QC_AbstractPollableIoObjectBase.dox.h:8
The ReadOnlyFile class allows Qore programs to read existing files.
Definition: QC_ReadOnlyFile.dox.h:23
bool isDataAvailable(timeout timeout_ms=0)
Returns True if there is data available for reading from the file within the timeout period.
static binary readBinaryFile(string path, int max_file_len=-1)
returns the contents of a binary file as a binary object
*int readi8()
Reads an 8-byte (64 bit) signed integer from the file in binary big-endian format or NOTHING if no da...
*int readu2()
Reads a 2-byte (16 bit) unsigned integer from the ReadOnlyFile in binary big-endian format or NOTHING...
*int readu4LSB()
Reads a 4-byte (32 bit) unsigned integer from the file in binary little-endian format or NOTHING if n...
bool isOpen()
returns True if the File is open, False if not
static hash< StatInfo > hstat(string path)
Returns a StatInfo hash about the file's status (follows symbolic links) or throws an exception if an...
*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.
int setPos(int pos=0)
Sets the current file position (in bytes from the beginning of the file)
*int readu2LSB()
Reads a 2-byte (16 bit) unsigned integer from the file in binary little-endian format or NOTHING if n...
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
nothing setEventQueue()
Removes any Queue object from the ReadOnlyFile object so that file events are no longer added to the ...
nothing open(string path, *string encoding)
Opens a file in a particular mode; throws an exception on failure.
constructor(string path, *string encoding)
Creates the ReadOnlyFile object.
*int readi4LSB()
Reads a 4-byte (32 bit) signed integer from the file in binary little-endian format or NOTHING if no ...
hash< StatInfo > hstat()
Returns a StatInfo hash about the file's status or throws an exception if any errors occur.
*int readi2()
Reads a 2-byte (16 bit) signed integer from the file in binary big-endian format or NOTHING if no dat...
hash< FilesystemInfo > statvfs()
Returns a FilesystemInfo hash about the file's filesystem status or throws an exception if any errors...
string getEncoding()
Returns the character encoding for the ReadOnlyFile.
static list< auto > stat(string path)
Returns a Stat List about the file's status (follows symbolic links) or throws an exception if any er...
nothing setEventQueue(Queue queue, auto arg, *bool with_data)
Sets a Queue object to receive file events.
AbstractPollOperation startPollRead(string path, bool to_string=True, int to_read=-1)
Returns an AbstractPollOperation object to read a file from the filesystem.
int getPos()
Returns the current file position as an integer giving the offset in bytes from the beginning of the ...
*string getFileName()
returns the file path/name used to open the file if the file is open, otherwise NOTHING
copy()
Creates a new ReadOnlyFile object with the same character encoding specification as the original,...
*int readi4()
Reads a 4-byte (32 bit) signed integer from the file in binary big-endian format or NOTHING if no dat...
int close()
Closes the ReadOnlyFile object.
destructor()
Closes the ReadOnlyFile if it is open and destroys the ReadOnlyFile object.
*string getchar()
Reads one character from the file and returns it as a string; returns NOTHING if no data can be 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...
nothing setEncoding(*string encoding)
Sets the character encoding for the ReadOnlyFile; if called with no argument, the default encoding is...
*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 ...
static hash< StatInfo > hlstat(string path)
Returns a StatInfo hash about the file's status (does not follow symbolic links) or throws an excepti...
*int readi2LSB()
Reads a 2-byte (16 bit) signed integer from the file in binary little-endian format or NOTHING if no ...
*int readu4()
Reads a 4-byte (32 bit) unsigned integer from the file in big-endian format or NOTHING if no data can...
*int readu1()
Reads a 1-byte unsigned integer from the ReadOnlyFile in binary format or NOTHING if no data can be r...
*int readi8LSB()
Reads an 8-byte (64 bit) signed integer from the file in binary little-endian format or NOTHING if no...
list< auto > stat()
Returns a Stat List about the file's status or throws an exception if any errors occur.
static list< auto > lstat(string path)
Returns a Stat List about the given path's status (does not follow symbolic links) or throws an excep...
static hash< FilesystemInfo > statvfs(string path)
Returns a FilesystemInfo hash about filesystem status of the given path; throws an exception if any e...
*int readi1()
Reads a 1-byte signed integer from the file in binary format or NOTHING if no data can be read.
bool isTty()
returns True if the File is connected to a terminal device, False if not
const True
logical True
Definition: qc_qore.dox.h:98
const S_IWUSR
Bit signifying if the file's owner has write permissions.
Definition: QC_ReadOnlyFile.dox.h:928
const S_IFMT
File type bitmask
Definition: QC_ReadOnlyFile.dox.h:898
const S_IFWHT
Bitmask signifying if the file is a whiteout file; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:904
const S_IFSOCK
Bitmask signifying if the file is a socket file; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:902
const S_IFLNK
Bitmask signifying if the file is a symbolic link; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:896
const S_IFBLK
Bitmask signifying if the file is a block special (device) file.
Definition: QC_ReadOnlyFile.dox.h:890
const S_ISVTX
Bit signifying restricted deletes for directories; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:922
const S_IRGRP
Bit signifying if the file's group has read permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:906
const S_ISUID
Bit signifying set user id on execution; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:920
const S_ISGID
Bit signifying set group id on execution; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:918
const S_IXUSR
Bit signifying if the file's owner has execute permissions.
Definition: QC_ReadOnlyFile.dox.h:934
const S_IWGRP
Bit signifying if the file's group has write permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:924
const S_IRWXG
Bitmask giving the RWX mask for the group; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:912
const S_IRUSR
Bit signifying if the file's owner has read permissions.
Definition: QC_ReadOnlyFile.dox.h:910
const S_IFREG
Bit signifying if the file is a regular file.
Definition: QC_ReadOnlyFile.dox.h:900
const S_IRWXO
Bitmask giving the RWX mask for other; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:914
const S_IFDIR
Bit signifying if the entry is a directory.
Definition: QC_ReadOnlyFile.dox.h:894
const S_IWOTH
Bit signifying if other has write permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:926
const S_IXOTH
Bit signifying if other has execute permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:932
const S_IXGRP
Bit signifying if the file's group has execute permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:930
const S_IRWXU
Bitmask giving the RWX mask for the owner.
Definition: QC_ReadOnlyFile.dox.h:916
const S_IROTH
Bit signifying if other has read permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:908
const S_IFCHR
Bit signifying if the file is a character special (device) file.
Definition: QC_ReadOnlyFile.dox.h:892
binary binary()
Always returns an empty binary object (of zero length)
Qore namespace.
Definition: QC_AbstractSmartLock.dox.h:2