Wrapper for stat() and lstat() system calls. More...

#include <fileStat.H>

Public Member Functions
	fileStat ()
	Default construct.
	fileStat (const char *fName, const bool followLink=true, const unsigned int maxTime=0)
	Construct from components.
	fileStat (const fileName &fName, const bool followLink=true, const unsigned int maxTime=0)
	Construct from components.
	fileStat (Istream &is)
	Construct from Istream.
bool	good () const noexcept
	True if file-stat was successful.
	operator bool () const noexcept
	True if file-stat was successful.
const struct stat &	status () const noexcept
	The raw status.
label	size () const
	Size in bytes, 0 for an invalid file-stat.
time_t	modTime () const
	The modification time in seconds, 0 for an invalid file-stat.
double	dmodTime () const
	The modification time in seconds (nanosecond resolution), 0 for an invalid file-stat.
bool	sameDevice (const fileStat &other) const
	Compare two fileStats for same device.
bool	sameINode (const fileStat &other) const
	Compare two fileStats for same Inode.
bool	sameINode (const label iNode) const
	Compare state against inode.
bool	valid () const noexcept
	True if file-stat was successful.

Friends
Istream &	operator>> (Istream &is, fileStat &fs)
Ostream &	operator<< (Ostream &os, const fileStat &fs)

Detailed Description

Wrapper for stat() and lstat() system calls.

Warning: On Linux (an maybe on others) a stat() of an nfs mounted (remote) file does never timeout and cannot be interrupted! So e.g. Foam::ping first and hope nfs is running.

Source files

Definition at line 63 of file fileStat.H.

Constructor & Destructor Documentation

◆ fileStat() [1/4]

fileStat ( )

Default construct.

Definition at line 33 of file fileStat.C.

Referenced by fileStat(), operator<<, operator>>, sameDevice(), and sameINode().

Here is the caller graph for this function:

◆ fileStat() [2/4]

fileStat	(	const char *	fName,
		const bool	followLink = true,
		const unsigned int	maxTime = 0 )

explicit

Construct from components.

Parameters

fName	The file name or directory name to stat.
followLink	If it is a link, get the status of the source file/directory.
maxTime	The timeout value.

Note: An empty filename is a no-op.

Definition at line 39 of file fileStat.C.

References timedOut.

◆ fileStat() [3/4]

fileStat	(	const fileName &	fName,
		const bool	followLink = true,
		const unsigned int	maxTime = 0 )

explicit

Construct from components.

Parameters

fName	The file name or directory name to stat.
followLink	If it is a link, get the status of the source file/directory.
maxTime	The timeout value.

Note: An empty filename is a no-op.

Definition at line 75 of file fileStat.C.

References fileStat().

Here is the call graph for this function:

◆ fileStat() [4/4]

fileStat ( Istream & is )

explicit

Construct from Istream.

Definition at line 86 of file fileStat.C.

Member Function Documentation

◆ good()

bool good ( ) const

inlinenoexcept

True if file-stat was successful.

Definition at line 130 of file fileStat.H.

References Foam::noexcept.

Referenced by Foam::fileSize(), Foam::mode(), and valid().

Here is the caller graph for this function:

◆ operator bool()

operator bool ( ) const

inlineexplicitnoexcept

True if file-stat was successful.

Definition at line 138 of file fileStat.H.

References Foam::noexcept.

◆ status()

const struct stat & status ( ) const

inlinenoexcept

The raw status.

Definition at line 146 of file fileStat.H.

References Foam::noexcept.

Referenced by Foam::fileSize(), and Foam::mode().

Here is the caller graph for this function:

◆ size()

Foam::label size ( ) const

Size in bytes, 0 for an invalid file-stat.

Definition at line 94 of file fileStat.C.

◆ modTime()

time_t modTime ( ) const

The modification time in seconds, 0 for an invalid file-stat.

Definition at line 100 of file fileStat.C.

Referenced by Foam::lastModified().

Here is the caller graph for this function:

◆ dmodTime()

double dmodTime ( ) const

The modification time in seconds (nanosecond resolution), 0 for an invalid file-stat.

Definition at line 106 of file fileStat.C.

References e, and else.

Referenced by Foam::highResLastModified().

Here is the caller graph for this function:

◆ sameDevice()

bool sameDevice ( const fileStat & other ) const

Compare two fileStats for same device.

Definition at line 122 of file fileStat.C.

References fileStat().

Here is the call graph for this function:

◆ sameINode() [1/2]

bool sameINode ( const fileStat & other ) const

Compare two fileStats for same Inode.

Definition at line 133 of file fileStat.C.

References fileStat().

Here is the call graph for this function:

◆ sameINode() [2/2]

bool sameINode ( const label iNode ) const

Compare state against inode.

Definition at line 139 of file fileStat.C.

◆ valid()

bool valid ( ) const

inlinenoexcept

True if file-stat was successful.

Definition at line 198 of file fileStat.H.

References good(), and Foam::noexcept.

Here is the call graph for this function:

◆ operator>>

Istream & operator>>	(	Istream &	is,
		fileStat &	fs )

friend

References fileStat().

◆ operator<<

Ostream & operator<<	(	Ostream &	os,
		const fileStat &	fs )

friend

References fileStat(), and os().

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

src/OSspecific/POSIX/fileStat/fileStat.H
src/OSspecific/POSIX/fileStat/fileStat.C

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ fileStat() [1/4]

◆ fileStat() [2/4]

◆ fileStat() [3/4]

◆ fileStat() [4/4]

Member Function Documentation

◆ good()

◆ operator bool()

◆ status()

◆ size()

◆ modTime()

◆ dmodTime()

◆ sameDevice()

◆ sameINode() [1/2]

◆ sameINode() [2/2]

◆ valid()

Friends And Related Symbol Documentation

◆ operator>>

◆ operator<<