C++ counterparts of SPL native functions that deal with file operations. More...

Functions

void mkdir (const SPL::rstring &name, SPL::uint32 mode, SPL::int32 &err)

void remove (const SPL::rstring &name, SPL::int32 &err)

void remove (const SPL::ustring &name, SPL::int32 &err)

SPL::uint64 fopen (const SPL::rstring &filename, const SPL::rstring &mode, SPL::int32 &err)

SPL::uint64 fopen (const SPL::ustring &filename, const SPL::ustring &mode, SPL::int32 &err)

SPL::int32 fclose (const SPL::uint64 file, SPL::int32 &err)

SPL::int32 fflush (const SPL::uint64 file, SPL::int32 &err)

SPL::int64 ftell (const SPL::uint64 file, SPL::int32 &err)

void fseek (const SPL::uint64 file, const SPL::int64 offset, const SPL::int32 whence, SPL::int32 &err)

SPL::int32 optSEEK_SET ()

SPL::int32 optSEEK_CUR ()

SPL::int32 optSEEK_END ()

void rewind (const SPL::uint64 file)

SPL::boolean feof (const SPL::uint64 file)

void clearerr (const SPL::uint64 file)

void fstat (const SPL::rstring &file, const SPL::rstring &what, SPL::uint64 &result, SPL::int32 &err)

void fstat (const SPL::ustring &file, const SPL::ustring &what, SPL::uint64 &result, SPL::int32 &err)

void fstat (const SPL::rstring &file, const SPL::rstring &what, SPL::timestamp &result, SPL::int32 &err)

void fstat (const SPL::ustring &file, const SPL::ustring &what, SPL::timestamp &result, SPL::int32 &err)

void fstat (const SPL::uint64 file, const SPL::rstring &what, SPL::uint64 &result, SPL::int32 &err)

void fstat (const SPL::uint64 file, const SPL::ustring &what, SPL::uint64 &result, SPL::int32 &err)

void fstat (const SPL::uint64 file, const SPL::rstring &what, SPL::timestamp &result, SPL::int32 &err)

void fstat (const SPL::uint64 file, const SPL::ustring &what, SPL::timestamp &result, SPL::int32 &err)

void fwriteString (const char *val, SPL::uint64 len, const SPL::uint64 file, SPL::int32 &err)

void fwriteString (const SPL::rstring &val, const SPL::uint64 file, SPL::int32 &err)

void fwriteString (const SPL::BString &val, const SPL::uint64 file, SPL::int32 &err)

void fwriteString (const SPL::ustring &val, const SPL::uint64 file, SPL::int32 &err)

void fwriteTxt (const SPL::ConstValueHandle &val, const SPL::uint64 file, SPL::int32 &err)

void fwriteBin (const SPL::ConstValueHandle &val, const SPL::uint64 file, SPL::int32 &err)

void fwrite (const SPL::list< SPL::uint8 > &val, const SPL::uint64 file, const SPL::uint64 loffset, const SPL::uint64 length, SPL::int32 &err)

SPL::rstring freadToken (const SPL::uint64 file, SPL::int32 &err)

SPL::rstring freadLine (const SPL::uint64 file, SPL::int32 &err)

template<class T >

void freadTxt (T &res, const SPL::uint64 file, SPL::int32 &err)

template<class T >

void freadBin (T &res, const SPL::uint64 file, SPL::int32 &err)

SPL::uint64 fread (SPL::list< SPL::uint8 > &res, const SPL::uint64 file, const SPL::uint64 length, SPL::int32 &err)

void freadfile (SPL::blob &res, const SPL::uint64 file, SPL::int32 &err)

void fwriteblob (const SPL::blob &b, const SPL::uint64 file, SPL::int32 &err)

SPL::boolean isEOF (const SPL::uint32 v)

SPL::boolean isEACCES (const SPL::uint32 v)

SPL::boolean isEAGAIN (const SPL::uint32 v)

SPL::boolean isEBADF (const SPL::uint32 v)

SPL::boolean isEFAULT (const SPL::uint32 v)

SPL::boolean isEFBIG (const SPL::uint32 v)

SPL::boolean isEINTR (const SPL::uint32 v)

SPL::boolean isEINVAL (const SPL::uint32 v)

SPL::boolean isEIO (const SPL::uint32 v)

SPL::boolean isEISDIR (const SPL::uint32 v)

SPL::boolean isEMFILE (const SPL::uint32 v)

SPL::boolean isENFILE (const SPL::uint32 v)

SPL::boolean isELOOP (const SPL::uint32 v)

SPL::boolean isENAMETOOLONG (const SPL::uint32 v)

SPL::boolean isENODEV (const SPL::uint32 v)

SPL::boolean isENOENT (const SPL::uint32 v)

SPL::boolean isENOMEM (const SPL::uint32 v)

SPL::boolean isENOSPC (const SPL::uint32 v)

SPL::boolean isENOTDIR (const SPL::uint32 v)

SPL::boolean isENXIO (const SPL::uint32 v)

SPL::boolean isEOVERFLOW (const SPL::uint32 v)

SPL::boolean isEPIPE (const SPL::uint32 v)

SPL::boolean isEPERM (const SPL::uint32 v)

SPL::boolean isEROFS (const SPL::uint32 v)

SPL::boolean isESPIPE (const SPL::uint32 v)

SPL::boolean isETXTBSY (const SPL::uint32 v)

SPL::boolean isEWOULDBLOCK (const SPL::uint32 v)

Detailed Description

C++ counterparts of SPL native functions that deal with file operations.

Function Documentation

void SPL::Functions::File::mkdir ( const SPL::rstring & name,

SPL::uint32 mode,

SPL::int32 & err

)

inline

Create a directory

Parameters

name Directory name. This must be a fully qualified name. You may use builtin functions like dataDirectory to construct the fully qualified name.

mode The permissions to be set on the new directory. This should have the equivalent values that would be passed to the C mkdir function.

err Set to 0 on success, errno value on failure.

void SPL::Functions::File::remove ( const SPL::rstring & name,

SPL::int32 & err

)

inline

Remove a file or directory.

Parameters

name File or directory name. This must be a fully qualified name. You may use builtin functions like dataDirectory to construct the fully qualified name.

err Set to 0 on success, errno value on failure.

void SPL::Functions::File::remove ( const SPL::ustring & name,

SPL::int32 & err

)

inline

Remove a file or directory.

Parameters

name File or directory name. This must be a fully qualified name. You may use builtin functions like dataDirectory to construct the fully qualified name.

err Set to 0 on success, errno value on failure.

SPL::uint64 SPL::Functions::File::fopen ( const SPL::rstring & filename,

const SPL::rstring & mode,

SPL::int32 & err

)

inline

Open a file.

Parameters

filename File to open. This must be a fully qualified name. You may use builtin functions like dataDirectory to construct the fully qualified name.

mode How the file is to be used (for reading, writing, etc).

err Set to 0 on success, errno value on failure.

Returns: The FILE* for the file, encoded as uint64.

SPL::uint64 SPL::Functions::File::fopen ( const SPL::ustring & filename,

const SPL::ustring & mode,

SPL::int32 & err

)

inline

Open a file.

Parameters

filename File to open. This must be a fully qualified name. You may use builtin functions like dataDirectory to construct the fully qualified name.

mode How the file is to be used (for reading, writing, etc).

err Error, if any.

Returns: The FILE* for the file, encoded as uint64.

SPL::int32 SPL::Functions::File::fclose ( const SPL::uint64 file,

SPL::int32 & err

)

inline

Close a file.

Parameters

file File to close (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

Returns: Return code from fclose.

SPL::int32 SPL::Functions::File::fflush ( const SPL::uint64 file,

SPL::int32 & err

)

inline

Flush a file to disk.

Parameters

file File to flush (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

Returns: Return code from fflush.

SPL::int64 SPL::Functions::File::ftell ( const SPL::uint64 file,

SPL::int32 & err

)

inline

Return the current file position.

Parameters

file File (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

Returns: File position.

void SPL::Functions::File::fseek ( const SPL::uint64 file,

const SPL::int64 offset,

const SPL::int32 whence,

SPL::int32 & err

)

inline

Set the current file position.

Parameters

file File (FILE* encoded as uint64).

offset Position to seek to.

whence Indicator of where position is relative to.

err Set to 0 on success, errno value on failure.

SPL::int32 SPL::Functions::File::optSEEK_SET ( )

inline

Indicator to seek relative to start of file.

Returns: SEEK_SET.

SPL::int32 SPL::Functions::File::optSEEK_CUR ( )

inline

Indicator to seek relative to current file position.

Returns: SEEK_CUR.

SPL::int32 SPL::Functions::File::optSEEK_END ( )

inline

Indicator to seek relative to end of file.

Returns: SEEK_END.

void SPL::Functions::File::rewind ( const SPL::uint64 file )

inline

Set the current file position to file start.

Parameters

file File (FILE* encoded as uint64).

SPL::boolean SPL::Functions::File::feof ( const SPL::uint64 file )

inline

Test if the stream is at end of file.

Parameters

file File (FILE* encoded as uint64).

Returns: The value 'true' if the stream is at the end of file.

void SPL::Functions::File::clearerr ( const SPL::uint64 file )

inline

Clear end of file indicator.

Parameters

file File (FILE* encoded as uint64).

void SPL::Functions::File::fstat ( const SPL::rstring & file,

const SPL::rstring & what,

SPL::uint64 & result,

SPL::int32 & err

)

Return information about a file.

Parameters

file File name. This must be a fully qualified name. You may use builtin functions like dataDirectory to construct the fully qualified name.

what Desired information: one of dev/rdev/ino/mode/nlink/uid/gid/size/blksize/blocks.

result Returned information.

err Set to 0 on success, errno value on failure (set to EINVAL if what string is not valid).

void SPL::Functions::File::fstat ( const SPL::ustring & file,

const SPL::ustring & what,

SPL::uint64 & result,

SPL::int32 & err

)

inline

Return information about a file.

Parameters

file File name. This must be a fully qualified name. You may use builtin functions like dataDirectory to construct the fully qualified name.

what Desired information: one of dev/rdev/ino/mode/nlink/uid/gid/size/blksize/blocks.

result Returned information.

err Set to 0 on success, errno value on failure (set to EINVAL if what string is not valid).

void SPL::Functions::File::fstat ( const SPL::rstring & file,

const SPL::rstring & what,

SPL::timestamp & result,

SPL::int32 & err

)

Return timestamp information about a file.

Parameters

file File name. This must be a fully qualified name. You may use builtin functions like dataDirectory to construct the fully qualified name.

what Desired information: one of atime/mtime/ctime.

result Returned information.

err Set to 0 on success, errno value on failure (set to EINVAL if what string is not valid).

void SPL::Functions::File::fstat ( const SPL::ustring & file,

const SPL::ustring & what,

SPL::timestamp & result,

SPL::int32 & err

)

inline

Return timestamp information about a file.

Parameters

file File name. This must be a fully qualified name. You may use builtin functions like dataDirectory to construct the fully qualified name.

what Desired information: one of atime/mtime/ctime.

result Returned information.

err Set to 0 on success, errno value on failure (set to EINVAL if what string is not valid).

void SPL::Functions::File::fstat ( const SPL::uint64 file,

const SPL::rstring & what,

SPL::uint64 & result,

SPL::int32 & err

)

Return information about a file.

Parameters

file File (FILE * encoded as uint64).

what Desired information: one of dev/rdev/ino/mode/nlink/uid/gid/size/blksize/blocks.

result Returned information.

err Set to 0 on success, errno value on failure (set to EINVAL if what string is not valid).

void SPL::Functions::File::fstat ( const SPL::uint64 file,

const SPL::ustring & what,

SPL::uint64 & result,

SPL::int32 & err

)

inline

Return information about a file.

Parameters

file File (FILE * encoded as uint64).

what Desired information: one of dev/rdev/ino/mode/nlink/uid/gid/size/blksize/blocks.

result Returned information.

err Set to 0 on success, errno value on failure (set to EINVAL if what string is not valid).

void SPL::Functions::File::fstat ( const SPL::uint64 file,

const SPL::rstring & what,

SPL::timestamp & result,

SPL::int32 & err

)

Return timestamp information about a file.

Parameters

file File (FILE * encoded as uint64).

what Desired information: one of atime/mtime/ctime.

result Returned information.

err Set to 0 on success, errno value on failure (set to EINVAL if what string is not valid).

void SPL::Functions::File::fstat ( const SPL::uint64 file,

const SPL::ustring & what,

SPL::timestamp & result,

SPL::int32 & err

)

inline

Return timestamp information about a file.

Parameters

file File (FILE * encoded as uint64).

what Desired information: one of atime/mtime/ctime.

result Returned information.

err Set to 0 on success, errno value on failure (set to EINVAL if what string is not valid).

void SPL::Functions::File::fwriteString ( const char * val,

SPL::uint64 len,

const SPL::uint64 file,

SPL::int32 & err

)

Write a string to a file.

Parameters

val Rstring value to be written.

len Length of the value to be written.

file File (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

void SPL::Functions::File::fwriteString ( const SPL::rstring & val,

const SPL::uint64 file,

SPL::int32 & err

)

inline

Write a string to a file.

Parameters

val Rstring value to be written.

file File (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

void SPL::Functions::File::fwriteString ( const SPL::BString & val,

const SPL::uint64 file,

SPL::int32 & err

)

inline

Write a string to a file.

Parameters

val Rstring value to be written.

file File (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

void SPL::Functions::File::fwriteString ( const SPL::ustring & val,

const SPL::uint64 file,

SPL::int32 & err

)

inline

Write a string to a file.

Parameters

val Rstring value to be written.

file File (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

void SPL::Functions::File::fwriteTxt ( const SPL::ConstValueHandle & val,

const SPL::uint64 file,

SPL::int32 & err

)

Write an SPL Value to a file as a text string.

Parameters

val Value to be written in serialized form.

file File (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

void SPL::Functions::File::fwriteBin ( const SPL::ConstValueHandle & val,

const SPL::uint64 file,

SPL::int32 & err

)

Write an SPL Value to a file as a binary value.

Parameters

val Value to be written in serialized form.

file File (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

void SPL::Functions::File::fwrite ( const SPL::list< SPL::uint8 > & val,

const SPL::uint64 file,

const SPL::uint64 loffset,

const SPL::uint64 length,

SPL::int32 & err

)

Write a list of bytes to a file as binary.

Parameters

val List of bytes to be written.

file File (FILE* encoded as uint64).

loffset Starting offset in list.

length Number of elements in list to be written.

err Set to 0 on success, errno value on failure.

SPL::rstring SPL::Functions::File::freadToken ( const SPL::uint64 file,

SPL::int32 & err

)

Read a 'token' from a file. A token is a series of non-whitespace characters. Whitespace is skipped until a non-whitespace character is found, and then all non-whitespace characters in the token are returned.

Parameters

file File (FILE* encoded as uint64).

err Set to 0 on success, -1 if EOF reached.

Returns: Token read from the file. Token is empty if EOF.

SPL::rstring SPL::Functions::File::freadLine ( const SPL::uint64 file,

SPL::int32 & err

)

Read a line from a file.

Parameters

file File (FILE* encoded as uint64).

err Set to 0 on success, -1 if EOF reached.

Returns: Line read from the file (new line character is not included).

template<class T >

void SPL::Functions::File::freadTxt ( T & res,

const SPL::uint64 file,

SPL::int32 & err

)

inline

Read an SPL Value from a file as a text string.

Parameters

res Value to read from the file (should have been written using fwriteTxt).

file File (FILE* encoded as uint64).

err Set to 0 on success, -1 if EOF reached, EIO if error deserializing.

template<class T >

void SPL::Functions::File::freadBin ( T & res,

const SPL::uint64 file,

SPL::int32 & err

)

inline

Read an SPL Value from a file as a binary value.

Parameters

res Value to read from the file (should have been written using fwriteBin).

file File (FILE* encoded as uint64).

err Set to 0 on success, -1 if EOF reached, EIO if error deserializing.

SPL::uint64 SPL::Functions::File::fread ( SPL::list< SPL::uint8 > & res,

const SPL::uint64 file,

const SPL::uint64 length,

SPL::int32 & err

)

Read a list of bytes from a file as binary.

Parameters

res List of bytes read.

file File (FILE* encoded as uint64).

length Number of bytes to be read.

err Set to 0 on success, -1 if EOF reached.

Returns: Number of bytes read.

void SPL::Functions::File::freadfile ( SPL::blob & res,

const SPL::uint64 file,

SPL::int32 & err

)

Read a whole file into a blob as binary.

Parameters

res Blob of bytes read.

file File (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

void SPL::Functions::File::fwriteblob ( const SPL::blob & b,

const SPL::uint64 file,

SPL::int32 & err

)

Write a blob into a file as binary.

Parameters

b Blob of bytes to be written at the current position.

file File (FILE* encoded as uint64).

err Set to 0 on success, errno value on failure.

SPL::boolean SPL::Functions::File::isEOF ( const SPL::uint32 v )

inline

Return whether the value is EOF.

Parameters

v Value.

Returns: The value 'true' if value is EOF.

SPL::boolean SPL::Functions::File::isEACCES ( const SPL::uint32 v )

inline

Return whether the value is EACCES.

Parameters

v Value.

Returns: The value 'true' if value is EACCES.

SPL::boolean SPL::Functions::File::isEAGAIN ( const SPL::uint32 v )

inline

Return whether the value is EAGAIN.

Parameters

v Value.

Returns: The value 'true' if value is EAGAIN.

SPL::boolean SPL::Functions::File::isEBADF ( const SPL::uint32 v )

inline

Return whether the value is EBADF.

Parameters

v Value.

Returns: The value 'true' if value is EBADF.

SPL::boolean SPL::Functions::File::isEFAULT ( const SPL::uint32 v )

inline

Return whether the value is EFAULT.

Parameters

v Value.

Returns: The value 'true' if value is EFAULT.

SPL::boolean SPL::Functions::File::isEFBIG ( const SPL::uint32 v )

inline

Return whether the value is EFBIG.

Parameters

v Value.

Returns: The value 'true' if value is EFBIG.

SPL::boolean SPL::Functions::File::isEINTR ( const SPL::uint32 v )

inline

Return whether the value is EINTR.

Parameters

v Value.

Returns: The value 'true' if value is EINTR.

SPL::boolean SPL::Functions::File::isEINVAL ( const SPL::uint32 v )

inline

Return whether the value is EINVAL.

Parameters

v Value.

Returns: The value 'true' if value is EINVAL.

SPL::boolean SPL::Functions::File::isEIO ( const SPL::uint32 v )

inline

Return whether the value is EIO.

Parameters

v Value.

Returns: The value 'true' if value is EIO.

SPL::boolean SPL::Functions::File::isEISDIR ( const SPL::uint32 v )

inline

Return whether the value is EISDIR.

Parameters

v Value.

Returns: The value 'true' if value is EISDIR.

SPL::boolean SPL::Functions::File::isEMFILE ( const SPL::uint32 v )

inline

Return whether the value is EMFILE.

Parameters

v Value.

Returns: The value 'true' if value is EMFILE.

SPL::boolean SPL::Functions::File::isENFILE ( const SPL::uint32 v )

inline

Return whether the value is ENFILE.

Parameters

v Value.

Returns: The value 'true' if value is ENFILE.

SPL::boolean SPL::Functions::File::isELOOP ( const SPL::uint32 v )

inline

Return whether the value is ELOOP.

Parameters

v Value.

Returns: The value 'true' if value is ELOOP.

SPL::boolean SPL::Functions::File::isENAMETOOLONG ( const SPL::uint32 v )

inline

Return whether the value is ENAMETOOLONG.

Parameters

v Value.

Returns: The value 'true' if value is ENAMETOOLONG.

SPL::boolean SPL::Functions::File::isENODEV ( const SPL::uint32 v )

inline

Return whether the value is ENODEV.

Parameters

v Value.

Returns: The value 'true' if value is ENODEV.

SPL::boolean SPL::Functions::File::isENOENT ( const SPL::uint32 v )

inline

Return whether the value is ENOENT.

Parameters

v Value.

Returns: The value 'true' if value is ENOENT.

SPL::boolean SPL::Functions::File::isENOMEM ( const SPL::uint32 v )

inline

Return whether the value is ENOMEM.

Parameters

v Value.

Returns: The value 'true' if value is ENOMEM.

SPL::boolean SPL::Functions::File::isENOSPC ( const SPL::uint32 v )

inline

Return whether the value is ENOSPC.

Parameters

v Value.

Returns: The value 'true' if value is ENOSPC.

SPL::boolean SPL::Functions::File::isENOTDIR ( const SPL::uint32 v )

inline

Return whether the value is ENOTDIR.

Parameters

v Value.

Returns: The value 'true' if value is ENOTDIR.

SPL::boolean SPL::Functions::File::isENXIO ( const SPL::uint32 v )

inline

Return whether the value is ENXIO.

Parameters

v Value.

Returns: The value 'true' if value is ENXIO.

SPL::boolean SPL::Functions::File::isEOVERFLOW ( const SPL::uint32 v )

inline

Return whether the value is EOVERFLOW.

Parameters

v Value.

Returns: The value 'true' if value is EOVERFLOW.

SPL::boolean SPL::Functions::File::isEPIPE ( const SPL::uint32 v )

inline

Return whether the value is EPIPE.

Parameters

v Value.

Returns: The value 'true' if value is EPIPE.

SPL::boolean SPL::Functions::File::isEPERM ( const SPL::uint32 v )

inline

Return whether the value is EPERM.

Parameters

v Value.

Returns: The value 'true' if value is EPERM.

SPL::boolean SPL::Functions::File::isEROFS ( const SPL::uint32 v )

inline

Return whether the value is EROFS.

Parameters

v Value.

Returns: The value 'true' if value is EROFS.

SPL::boolean SPL::Functions::File::isESPIPE ( const SPL::uint32 v )

inline

Return whether the value is ESPIPE.

Parameters

v Value.

Returns: The value 'true' if value is ESPIPE.

SPL::boolean SPL::Functions::File::isETXTBSY ( const SPL::uint32 v )

inline

Return whether the value is ETXTBSY.

Parameters

v Value.

Returns: The value 'true' if value is ETXTBSY.

SPL::boolean SPL::Functions::File::isEWOULDBLOCK ( const SPL::uint32 v )

inline

Return whether the value is EWOULDBLOCK.

Parameters

v Value.

Returns: The value 'true' if value is EWOULDBLOCK.