5 class File :
public ReadOnlyFile {
70 nothing
chown(softint uid, softint gid = -1);
352 int open(
string path, softint flags =
O_RDONLY, softint mode = 0666, *
string encoding);
388 nothing
open2(
string path, softint flags =
O_RDONLY, softint mode = 0666, *
string encoding);
412 int print(
string data);
437 int printf(
string fmt, ...);
552 int vprintf(
string fmt, any fmt_args);
606 int write(
string data);
TermIOS getTerminalAttributes()
Returns the current terminal attributes for the file as a TermIOS object returned as the return value...
int writei2LSB(int s)
Writes a 2-byte (16 bit) integer to the file in binary little-endian format.
const TCSANOW
make change immediate
Definition: QC_TermIOS.dox.h:472
const O_EXCL
Raise an error if used with O_CREAT and the file exists.
Definition: QC_File.dox.h:771
constructor(*string encoding)
Creates the File object.
copy()
Creates a new File object with the same character encoding specification as the original, otherwise no other information is copied.
hash getLockInfo()
Returns a hash of lock information.
const F_UNLCK
Use for unlocking a lock.
Definition: QC_File.dox.h:801
nothing chown(softint uid, softint gid=-1)
Changes the user and group owners of the file on the filesystem (if the current user has sufficient p...
int writei8(int i)
Writes an 8-byte (64 bit) integer to the file in binary big-endian format.
int f_vprintf()
This method variant does nothing except return a constant 0; it is only included for backwards-compat...
nothing lockBlocking(softint type=F_RDLCK, softint start=0, softint len=0, softint whence=SEEK_SET)
Attempts to lock the file according to the arguments passed, blocking.
const O_RDWR
Open for reading and writing.
Definition: QC_File.dox.h:783
int vprintf()
This method variant does nothing except return a constant 0; it is only included for backwards-compat...
int writei4(int i)
Writes a 4-byte (32 bit) integer to the file in binary big-endian format.
binary binary()
Always returns an empty binary object (of zero length)
const O_NOFOLLOW
don't follow links (0 on platforms where this is not available)
Definition: QC_File.dox.h:777
const SEEK_CUR
Indicates that the offset is from the current position in the file.
Definition: QC_File.dox.h:811
int writei1(int c)
Writes a 1-byte integer to the file.
const O_DIRECTORY
must be a directory (0 on platforms where this is not available)
Definition: QC_File.dox.h:769
const O_DIRECT
direct disk access hint (0 on platforms where this is not available)
Definition: QC_File.dox.h:767
const O_APPEND
Open the file in append mode (append on each write)
Definition: QC_File.dox.h:763
int sync()
Flushes the file's buffer to disk.
int f_printf()
This method variant does nothing except return a constant 0; it is only included for backwards-compat...
int printf()
This method variant does nothing except return a constant 0; it is only included for backwards-compat...
const O_NONBLOCK
non-blocking I/O (untested with Qore; 0 on platforms where this is not available) ...
Definition: QC_File.dox.h:779
const O_ACCMODE
Mask for access modes (O_RDONLY|O_WRONLY|O_RDWR)
Definition: QC_File.dox.h:761
int writei8LSB(int i)
Writes an 8-byte (64 bit) integer to the file in binary little-endian format.
const F_RDLCK
Use for read-only locking.
Definition: QC_File.dox.h:799
nothing open2(string path, softint flags=O_RDONLY, softint mode=0666, *string encoding)
Opens a file in a particular mode; throws an exception on failure.
const O_CREAT
Create the file if it doesn't exist.
Definition: QC_File.dox.h:765
const SEEK_END
Indicates that the offset is from the end of the file.
Definition: QC_File.dox.h:813
string type(auto arg)
Returns a string giving the data type of the argument passed; see String Type Constants for the value...
int write(binary data)
Writes binary data to a file.
hash< auto > hash(object obj)
Returns a hash of an object's members.
const O_NOCTTY
don't allocate controlling tty (0 on platforms where this is not available)
Definition: QC_File.dox.h:775
destructor()
Closes the File if it is open and destroys the File object.
const F_WRLCK
Use for exclusive write locking.
Definition: QC_File.dox.h:803
int lock(softint type=F_RDLCK, softint start=0, softint len=0, softint whence=SEEK_SET)
Attempts to lock the file according to the arguments passed, does not block.
int writei2(int s)
Writes a 2-byte (16 bit) integer to the file in binary big-endian format.
const O_NDELAY
synonym for O_NONBLOCK (untested with Qore; 0 on platforms where this is not available) ...
Definition: QC_File.dox.h:773
string getCharset()
Returns the character encoding for the File.
int print(string data)
Writes string data to a file; string data is converted to the File's character encoding if necessary ...
const O_WRONLY
Open the file write-only.
Definition: QC_File.dox.h:789
const O_SYNC
synchronized file update option (0 on platforms where this is not available)
Definition: QC_File.dox.h:785
int writei4LSB(int i)
Writes a 4-byte (32 bit) integer to the file in binary little-endian format.
const O_RDONLY
Open the file read-only.
Definition: QC_File.dox.h:781
The File class allows Qore programs to read, write, and create files.
Definition: QC_File.dox.h:51
nothing setTerminalAttributes(softint action=TCSANOW, TermIOS termios)
Sets the current terminal attributes for the File from the TermIOS object passed; does not change the...
const SEEK_SET
Indicates that the offset is from the start of the file.
Definition: QC_File.dox.h:815
const O_TRUNC
Truncate the size to zero.
Definition: QC_File.dox.h:787
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
nothing setCharset(*string encoding)
Sets the character encoding for the file; if called with no argument, the default encoding is set...
nothing redirect(Qore::File file)
redirects an existing file to another file
int open(string path, softint flags=O_RDONLY, softint mode=0666, *string encoding)
Opens a File in a particular mode, returns an error code on failure.