Qore Programming Language Reference Manual  0.8.9
 All Classes Namespaces Functions Variables Groups Pages
QC_ReadOnlyFile.dox.h
1 namespace Qore {
4 
18 class ReadOnlyFile {
19 
20 public:
22 
35 int close();
36 
37 public:
39 
56  constructor(string path, *string encoding);
57 
58 public:
60 
65  copy();
66 
67 public:
69 
71  destructor();
72 
73 public:
75 
85 string getEncoding();
86 
87 public:
89 
101 *string getFileName();
102 
103 public:
105 
119 int getPos();
120 
121 public:
123 
136 *string getchar();
137 
138 public:
140 
156 hash hstat();
157 
158 public:
160 
177 bool isDataAvailable(timeout timeout_ms = 0);
178 
179 public:
181 
191 bool isOpen();
192 
193 public:
195 
207 bool isTty();
208 
209 public:
211 
237 nothing open(string path, *string encoding);
238 
239 public:
241 
267 *string read(softint size, timeout timeout_ms = -1);
268 
269 public:
271 
297 *binary readBinary(softint size, timeout timeout_ms = -1);
298 
299 public:
301 
326 *string readLine(bool incl_eol = True, *string eol);
327 
328 public:
330 
343 *int readi1();
344 
345 public:
347 
360 *int readi2();
361 
362 public:
364 
377 *int readi2LSB();
378 
379 public:
381 
394 *int readi4();
395 
396 public:
398 
411 *int readi4LSB();
412 
413 public:
415 
428 *int readi8();
429 
430 public:
432 
445 *int readi8LSB();
446 
447 public:
449 
462 *int readu1();
463 
464 public:
466 
479 *int readu2();
480 
481 public:
483 
496 *int readu2LSB();
497 
498 public:
500 
513 *int readu4();
514 
515 public:
517 
530 *int readu4LSB();
531 
532 public:
534 
543 nothing setEncoding(*string encoding);
544 
545 public:
547 
559 nothing setEventQueue(Qore::Thread::Queue queue);
560 
561 public:
563 
572 nothing setEventQueue();
573 
574 public:
576 
589 int setPos(int pos = 0);
590 
591 public:
593 
609 list stat();
610 
611 public:
613 
629 hash statvfs();
630 
631 public:
633 
647 static binary readBinaryFile(string path);
648 
649 public:
651 
666 static string readTextFile(string path, *string encoding);
667 };
672 
674  const S_IFBLK = S_IFBLK;
676  const S_IFCHR = S_IFCHR;
678  const S_IFDIR = S_IFDIR;
680  const S_IFLNK = S_IFLNK;
682  const S_IFMT = S_IFMT;
684  const S_IFREG = S_IFREG;
688  const S_IFWHT = S_IFWHT;
690  const S_IRGRP = S_IRGRP;
692  const S_IROTH = S_IROTH;
694  const S_IRUSR = S_IRUSR;
696  const S_IRWXG = S_IRWXG;
698  const S_IRWXO = S_IRWXO;
700  const S_IRWXU = S_IRWXU;
702  const S_ISGID = S_ISGID;
704  const S_ISUID = S_ISUID;
706  const S_ISVTX = S_ISVTX;
708  const S_IWGRP = S_IWGRP;
710  const S_IWOTH = S_IWOTH;
712  const S_IWUSR = S_IWUSR;
714  const S_IXGRP = S_IXGRP;
716  const S_IXOTH = S_IXOTH;
718  const S_IXUSR = S_IXUSR;
720 };
constructor(string path, *string encoding)
Creates the ReadOnlyFile object.
*int readu4()
Reads a 4-byte (32 bit) unsigned integer from the file in big-endian format or NOTHING if no data can...
const S_IFREG
Bit signifying if the file is a regular file.
Definition: QC_ReadOnlyFile.dox.h:684
*int readi4()
Reads a 4-byte (32 bit) signed integer from the file in binary big-endian format or NOTHING if no dat...
const S_IRWXO
Bitmask giving the RWX mask for other; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:698
const S_IFDIR
Bit signifying if the entry is a directory.
Definition: QC_ReadOnlyFile.dox.h:678
const S_IRWXU
Bitmask giving the RWX mask for the owner.
Definition: QC_ReadOnlyFile.dox.h:700
hash hstat()
Returns a Stat Hash about the file's status or throws an exception if any errors occur.
*int readu2LSB()
Reads a 2-byte (16 bit) unsigned integer from the file in binary little-endian format or NOTHING if n...
int setPos(int pos=0)
Sets the current file position (in bytes from the beginning of the file)
const S_IFWHT
Bitmask signifying if the file is a whiteout file; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:688
const True
logical True
Definition: qc_qore.dox.h:94
copy()
Creates a new ReadOnlyFile object with the same character encoding specification as the original...
nothing open(string path, *string encoding)
Opens a file in a particular mode; throws an exception on failure.
string getEncoding()
Returns the character encoding for the ReadOnlyFile.
const S_IXUSR
Bit signifying if the file's owner has execute permissions.
Definition: QC_ReadOnlyFile.dox.h:718
binary binary()
Always returns an empty binary object (of zero length)
bool isOpen()
returns True if the File is open, False if not
const S_IWUSR
Bit signifying if the file's owner has write permissions.
Definition: QC_ReadOnlyFile.dox.h:712
*string read(softint size, timeout timeout_ms=-1)
Reads a certain number of bytes from the ReadOnlyFile within an optional timeout period and returns a...
list list(...)
Returns a list of the arguments passed at the top level.
*string getFileName()
returns the file path/name used to open the file if the file is open, otherwise NOTHING ...
int close()
Closes 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 ...
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:690
*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 getPos()
Returns the current file position as an integer giving the offset in bytes from the beginning of the ...
hash statvfs()
Returns a Filesystem Status Hash about the file's filesystem status or throws an exception if any err...
destructor()
Closes the ReadOnlyFile if it is open and destroys the ReadOnlyFile object.
*int readi1()
Reads a 1-byte signed integer from the file in binary format or NOTHING if no data can be read...
const S_IFCHR
Bit signifying if the file is a character special (device) file.
Definition: QC_ReadOnlyFile.dox.h:676
*int readi2LSB()
Reads a 2-byte (16 bit) signed integer from the file in binary little-endian format or NOTHING if no ...
*int readi8()
Reads an 8-byte (64 bit) signed integer from the file in binary big-endian format or NOTHING if no da...
const S_IROTH
Bit signifying if other has read permissions; equal to 0 on native Windows ports. ...
Definition: QC_ReadOnlyFile.dox.h:692
*int readi4LSB()
Reads a 4-byte (32 bit) signed integer from the file in binary little-endian format or NOTHING if no ...
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)
returns the contents of a binary file as a binary object
const S_IWOTH
Bit signifying if other has write permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:710
list stat()
Returns a Stat List about the file's status or throws an exception if any errors occur.
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:714
const S_ISUID
Bit signifying set user id on execution; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:704
const S_IFLNK
Bitmask signifying if the file is a symbolic link; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:680
const S_ISVTX
Bit signifying restricted deletes for directories; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:706
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:708
const S_IFMT
File type bitmask
Definition: QC_ReadOnlyFile.dox.h:682
*int readu4LSB()
Reads a 4-byte (32 bit) unsigned integer from the file in binary little-endian format or NOTHING if n...
Queue objects provide a blocking, thread-safe message-passing object to Qore programs ...
Definition: QC_Queue.dox.h:13
*int readi2()
Reads a 2-byte (16 bit) signed integer from the file in binary big-endian format or NOTHING if no dat...
const S_IFBLK
Bitmask signifying if the file is a block special (device) file.
Definition: QC_ReadOnlyFile.dox.h:674
nothing setEventQueue()
Removes any Queue object from the ReadOnlyFile object so that file events are no longer added to the ...
nothing setEncoding(*string encoding)
Sets the character encoding for the ReadOnlyFile; if called with no argument, the default encoding is...
static string readTextFile(string path, *string encoding)
returns the contents of a text file as a string optionally tagged with the given character encoding ...
const S_ISGID
Bit signifying set group id on execution; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:702
bool isTty()
returns True if the File is connected to a terminal device, False if not
*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 ...
const S_IRWXG
Bitmask giving the RWX mask for the group; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:696
const S_IFSOCK
Bitmask signifying if the file is a socket file; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:686
hash hash(object obj)
Returns a hash of an object's members.
The ReadOnlyFile class allows Qore programs to read existing files.
Definition: QC_ReadOnlyFile.dox.h:18
*int readu1()
Reads a 1-byte unsigned integer from the ReadOnlyFile in binary format or NOTHING if no data can be r...
*int readu2()
Reads a 2-byte (16 bit) unsigned integer from the ReadOnlyFile in binary big-endian format or NOTHING...
const S_IRUSR
Bit signifying if the file's owner has read permissions.
Definition: QC_ReadOnlyFile.dox.h:694
const S_IXOTH
Bit signifying if other has execute permissions; equal to 0 on native Windows ports.
Definition: QC_ReadOnlyFile.dox.h:716
*int readi8LSB()
Reads an 8-byte (64 bit) signed integer from the file in binary little-endian format or NOTHING if no...