Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

Public Member Functions | Static Public Member Functions | List of all members
FX::FXStat Class Reference

Statistics about a file or directory. More...

#include <FXStat.h>

Public Member Functions

 FXStat ()
 File size. More...
 
FXuint mode () const
 Return the mode flags for this file.
 
FXuint user () const
 Return user number.
 
FXuint group () const
 Return group number.
 
FXuint links () const
 Return number of links to file.
 
FXTime created () const
 Return time when file was created, in nanoseconds.
 
FXTime accessed () const
 Return time when last accessed, in nanoseconds.
 
FXTime modified () const
 Return time when last modified, in nanoseconds.
 
FXlong volume () const
 Return file volume number.
 
FXlong index () const
 Return file index number.
 
FXlong size () const
 Return file size in bytes.
 
FXbool isHidden () const
 Return true if it is a hidden file (Windows-only)
 
FXbool isDirectory () const
 Return true if input path is a directory.
 
FXbool isFile () const
 Return true if it is a regular file.
 
FXbool isLink () const
 Return true if it is a link.
 
FXbool isSetUid () const
 Return true if the file sets the user id on execution.
 
FXbool isSetGid () const
 Return true if the file sets the group id on execution.
 
FXbool isSetSticky () const
 Return true if the file has the sticky bit set.
 
FXbool isDevice () const
 Return true if special device (character or block device)
 
FXbool isCharacter () const
 Return true if character device.
 
FXbool isBlock () const
 Return true if block device.
 
FXbool isSocket () const
 Return true if socket device.
 
FXbool isFifo () const
 Return true if fifo (pipe) device.
 
FXbool isReadable () const
 Return true if file is readable.
 
FXbool isWritable () const
 Return true if file is writable.
 
FXbool isExecutable () const
 Return true if file is executable.
 
FXbool isOwnerReadWriteExecute () const
 Return true if owner has read-write-execute permissions.
 
FXbool isOwnerReadable () const
 Return true if owner has read permissions.
 
FXbool isOwnerWritable () const
 Return true if owner has write permissions.
 
FXbool isOwnerExecutable () const
 Return true if owner has execute permissions.
 
FXbool isGroupReadWriteExecute () const
 Return true if group has read-write-execute permissions.
 
FXbool isGroupReadable () const
 Return true if group has read permissions.
 
FXbool isGroupWritable () const
 Return true if group has write permissions.
 
FXbool isGroupExecutable () const
 Return true if group has execute permissions.
 
FXbool isOtherReadWriteExecute () const
 Return true if others have read-write-execute permissions.
 
FXbool isOtherReadable () const
 Return true if others have read permissions.
 
FXbool isOtherWritable () const
 Return true if others have write permissions.
 
FXbool isOtherExecutable () const
 Return true if others have execute permissions.
 

Static Public Member Functions

static FXbool statFile (const FXString &file, FXStat &info)
 Get statistics of the file into the stat buffer info.
 
static FXbool statLink (const FXString &file, FXStat &info)
 Get statistice of the link into the stat buffer info.
 
static FXbool stat (const FXFile &file, FXStat &info)
 Get statistics of already open file into stat buffer info.
 
static FXuint mode (const FXString &file)
 Return the mode flags for this file.
 
static FXbool mode (const FXString &file, FXuint perm)
 Change the mode flags for this file.
 
static FXbool exists (const FXString &file)
 Return true if file exists.
 
static FXlong size (const FXString &file)
 Return file size in bytes.
 
static FXlong volume (const FXString &file)
 Return file volume number.
 
static FXlong index (const FXString &file)
 Return file index number.
 
static FXuint links (const FXString &file)
 Return number of links to file.
 
static FXTime modified (const FXString &file)
 Return last modified time for this file, on filesystems where this is supported. More...
 
static FXbool modified (const FXString &file, FXTime ns)
 Change modified time for the given file, on filesystems where this is supported. More...
 
static FXTime accessed (const FXString &file)
 Return last accessed time for this file, on filesystems where this is supported, in nanoseconds since Epoch.
 
static FXbool accessed (const FXString &file, FXTime ns)
 Change accessed time for the given file, on filesystems where this is supported. More...
 
static FXTime created (const FXString &file)
 Return created time for this file, on filesystems where this is supported. More...
 
static FXbool created (const FXString &file, FXTime ns)
 Change created time for the given file, on filesystems where this is supported. More...
 
static FXbool isHidden (const FXString &file)
 Return true if file is hidden.
 
static FXbool isFile (const FXString &file)
 Return true if input path is a file name.
 
static FXbool isLink (const FXString &file)
 Return true if input path is a link.
 
static FXbool isDirectory (const FXString &file)
 Return true if input path is a directory.
 
static FXbool isReadable (const FXString &file)
 Return true if file is readable.
 
static FXbool isWritable (const FXString &file)
 Return true if file is writable.
 
static FXbool isExecutable (const FXString &file)
 Return true if file is executable.
 
static FXbool isOwnerReadWriteExecute (const FXString &file)
 Return true if owner has read-write-execute permissions.
 
static FXbool isOwnerReadable (const FXString &file)
 Return true if owner has read permissions.
 
static FXbool isOwnerWritable (const FXString &file)
 Return true if owner has write permissions.
 
static FXbool isOwnerExecutable (const FXString &file)
 Return true if owner has execute permissions.
 
static FXbool isGroupReadWriteExecute (const FXString &file)
 Return true if group has read-write-execute permissions.
 
static FXbool isGroupReadable (const FXString &file)
 Return true if group has read permissions.
 
static FXbool isGroupWritable (const FXString &file)
 Return true if group has write permissions.
 
static FXbool isGroupExecutable (const FXString &file)
 Return true if group has execute permissions.
 
static FXbool isOtherReadWriteExecute (const FXString &file)
 Return true if others have read-write-execute permissions.
 
static FXbool isOtherReadable (const FXString &file)
 Return true if others have read permissions.
 
static FXbool isOtherWritable (const FXString &file)
 Return true if others have write permissions.
 
static FXbool isOtherExecutable (const FXString &file)
 Return true if others have execute permissions.
 
static FXbool isSetUid (const FXString &file)
 Return true if the file sets the user id on execution.
 
static FXbool isSetGid (const FXString &file)
 Return true if the file sets the group id on execution.
 
static FXbool isSetSticky (const FXString &file)
 Return true if the file has the sticky bit set.
 
static FXbool isAccessible (const FXString &file, FXuint m=FXIO::ReadWrite)
 Return true if file is accessible for access mode m (FXIO::ReadOnly, FXIO::WriteOnly, FXIO::ReadWrite, FXIO::Executable, etc.)
 
static FXbool isSame (const FXString &file1, const FXString &file2)
 Return true if file1 is the same as file2, even though they may have different paths. More...
 
static FXbool getTotalDiskSpace (const FXString &path, FXulong &space)
 Obtain total amount of space on disk mounted at given path.
 
static FXbool getAvailableDiskSpace (const FXString &path, FXulong &space)
 Obtain available amount of space on disk mounted at given path.
 

Detailed Description

Statistics about a file or directory.

Constructor & Destructor Documentation

◆ FXStat()

FX::FXStat::FXStat ( )
inline

File size.

Initialize

Member Function Documentation

◆ accessed()

static FXbool FX::FXStat::accessed ( const FXString &  file,
FXTime  ns 
)
static

Change accessed time for the given file, on filesystems where this is supported.

Time is specified in nanoseconds since Epoch.

◆ created() [1/2]

static FXTime FX::FXStat::created ( const FXString &  file)
static

Return created time for this file, on filesystems where this is supported.

This is also the time when ownership, permissions, links, and other meta-data may have changed, in nanoseconds since Epoch.

◆ created() [2/2]

static FXbool FX::FXStat::created ( const FXString &  file,
FXTime  ns 
)
static

Change created time for the given file, on filesystems where this is supported.

Time is specified in nanoseconds since Epoch.

◆ isSame()

static FXbool FX::FXStat::isSame ( const FXString &  file1,
const FXString &  file2 
)
static

Return true if file1 is the same as file2, even though they may have different paths.

◆ modified() [1/2]

static FXTime FX::FXStat::modified ( const FXString &  file)
static

Return last modified time for this file, on filesystems where this is supported.

This is the time when any data in the file was last modified, in nanoseconds since Epoch.

◆ modified() [2/2]

static FXbool FX::FXStat::modified ( const FXString &  file,
FXTime  ns 
)
static

Change modified time for the given file, on filesystems where this is supported.

Time is specified in nanoseconds since Epoch.

The documentation for this class was generated from the following file:

Copyright © 1997-2022 Jeroen van der Zijp