Description:

The entry type which is embedded in each tree node.

Definition at line 14 of file finfo.inl.

Inner Type Index:
struct	Bits
	A bitfield encoding various information. More...
struct	DirectorySums
	Recursively accumulated values for directories. More...
struct	EIDirectory
struct	EISymLinkDir
struct	EISymLinkFile
struct	ExtendedEntryInfo
	Base type to create pointers to different extended entry information structs. More...

Public Type Index:
enum class	Permissions : uint32_t { NONE = 0 , UNKNOWN = 010000 , MASK = 07777 , ALL = 0777 , OWNER_READ = 0400 , OWNER_WRITE = 0200 , OWNER_EXEC = 0100 , OWNER_ALL = 0700 , GROUP_READ = 040 , GROUP_WRITE = 020 , GROUP_EXEC = 010 , GROUP_ALL = 070 , OTHERS_READ = 04 , OTHERS_WRITE = 02 , OTHERS_EXEC = 01 , OTHERS_ALL = 07 , SET_UID = 04000 , SET_GID = 02000 , STICKY_BIT = 01000 }
	Permission flags. Compatible with posix* definition. More...
enum class	ScanStates : uint8_t { NONE = 0 , STATS = 1 , RESOLVED = 2 , MAX_DEPTH_REACHED = 3 , NOT_FOLLOWED = 4 , NOT_CROSSING_FS = 5 , NO_AFS = 6 , RECURSIVE = 7 , NO_ACCESS = 8 , NO_ACCESS_SL = 9 , NO_ACCESS_SL_TARGET =10 , NO_ACCESS_DIR =11 , BROKEN_LINK =12 , CIRCULAR_LINK =13 , DUPLICATE =14 , NOT_EXISTENT =15 , UNKNOWN_ERROR =16 }
	Per-entry information about how a node was scanned. More...
enum class	ScanStates3Letters : uint8_t { NONE = 0 , STATS = 1 , RESOLVED = 2 , MAX_DEPTH_REACHED = 3 , NOT_FOLLOWED = 4 , NOT_CROSSING_FS = 5 , NO_AFS = 6 , RECURSIVE = 7 , NO_ACCESS = 8 , NO_ACCESS_SL = 9 , NO_ACCESS_SL_TARGET =10 , NO_ACCESS_DIR =11 , BROKEN_LINK =12 , CIRCULAR_LINK =13 , DUPLICATE =14 , NOT_EXISTENT =15 , UNKNOWN_ERROR =16 }
using	TOwnerAndGroupID = uint32_t
	Type definition for owner and group ids.
enum class	TypeNames1Letter : uint8_t { DIRECTORY = 0 , SYMBOLIC_LINK_DIR = 1 , REGULAR = 2 , SYMBOLIC_LINK = 3 , BLOCK = 4 , CHARACTER = 5 , FIFO = 6 , SOCKET = 7 }
enum class	TypeNames2Letters : uint8_t { DIRECTORY = 0 , SYMBOLIC_LINK_DIR = 1 , REGULAR = 2 , SYMBOLIC_LINK = 3 , BLOCK = 4 , CHARACTER = 5 , FIFO = 6 , SOCKET = 7 }
enum class	TypeNames3Letters : uint8_t { DIRECTORY = 0 , SYMBOLIC_LINK_DIR = 1 , REGULAR = 2 , SYMBOLIC_LINK = 3 , BLOCK = 4 , CHARACTER = 5 , FIFO = 6 , SOCKET = 7 }
enum class	Types : uint8_t { DIRECTORY = 0 , SYMBOLIC_LINK_DIR = 1 , REGULAR = 2 , SYMBOLIC_LINK = 3 , BLOCK = 4 , CHARACTER = 5 , FIFO = 6 , SOCKET = 7 , UNKNOWN_OR_ERROR = 8 , MARKER_TYPES_END = 9 }

Public Static Field Index:
static constexpr TOwnerAndGroupID	UnknownID = (std::numeric_limits<uint32_t>::max)()
	Constant value for owner and group IDs to denote that the field was not determined.

Public Method Index:
constexpr DateTime	ADate () const noexcept
constexpr DateTime	BDate () const noexcept
constexpr DateTime	CDate () const noexcept
constexpr ExtendedEntryInfo *	GetExtendedInfo () const
system::CPathString &	GetLinkTarget () const noexcept
system::CPathString &	GetRealLinkTarget () const noexcept
constexpr uint32_t	Group () const noexcept
constexpr bool	IsArtificialFS () const noexcept
constexpr bool	IsCrossingFS () const noexcept
constexpr bool	IsDirectory () const noexcept
constexpr bool	IsSymbolicLink () const noexcept
constexpr DateTime	MDate () const noexcept
constexpr uint32_t	Owner () const noexcept
constexpr Permissions	Perms () const noexcept
constexpr uint32_t	QtyHardLinks () const noexcept
constexpr ScanStates	ScanState () const noexcept
void	SetADate (DateTime v) noexcept
void	SetArtificialFS () noexcept
	Mark the entry as residing on an artificial filesystem.
void	SetBDate (DateTime v) noexcept
void	SetCDate (DateTime v) noexcept
void	SetCrossingFS () noexcept
	Mark the entry as residing on a different filesystem than its parent.
constexpr void	SetExtendedInfo (ExtendedEntryInfo *extInfo)
void	SetGroup (uint32_t v) noexcept
void	SetLinkTarget (FTree &tree, const system::PathString &target, const system::PathString &realTarget)
void	SetMDate (DateTime v) noexcept
void	SetOwner (uint32_t v) noexcept
void	SetPerms (Permissions v) noexcept
void	SetQtyHardlinks (uint32_t v) noexcept
void	SetScanState (ScanStates v) noexcept
void	SetSize (uinteger v) noexcept
constexpr void	SetSums (const DirectorySums &sums) const
void	SetTargetArtificialFS () noexcept
	Mark the entry as a symlink who's target is residing on an artificial filesystem.
void	SetTargetCrossingFS () noexcept
	Mark the entry as a symlink who's target is residing in a different filesystem than the symlink.
void	SetType (Types v) noexcept
constexpr uinteger	Size () const noexcept
constexpr DirectorySums &	Sums () const
constexpr bool	TargetIsArtificialFS () const noexcept
constexpr bool	TargetIsCrossingFS () const noexcept
constexpr Types	Type () const noexcept

Protected Field Index:
DateTime	aDate
DateTime	bDate
Bits	bits
	A bitfield encoding various information.
DateTime	cDate
void *	custom = nullptr
	Pool-allocated custom data.
const std::type_info *	dbgCustomType = nullptr
	The custom type attached. Used for asserting misuse in debug-compilations.
ExtendedEntryInfo *	extendedInfo = nullptr
	Extended information, depending on the entry type.
uint32_t	group
	The group id that owns the file.
DateTime	mDate
uint32_t	owner
	The user id that owns the file.
uint32_t	qtyHardLinks
	The number of hard links to the file.
uinteger	size
	The file size. In case of a directory, this is `0`.
uinteger	symParent = 0

Type Definition Details:

◆ TOwnerAndGroupID

using alib::files::FInfo::TOwnerAndGroupID = uint32_t

Type definition for owner and group ids.

Definition at line 118 of file finfo.inl.

Enumeration Details:

◆ Permissions

enum class alib::files::FInfo::Permissions : uint32_t

strong

Permission flags. Compatible with posix* definition.

Enumerator
NONE	no permission bits are set
UNKNOWN	Unknown permissions (e.g., when not read, or filesystem does not support permissions).
MASK	All valid permission bits. Equivalent to all \| set_uid \| set_gid \| sticky_bit.
ALL	All users have read, write, and execute/search permissions Equivalent to owner_all \| group_all \| others_all.
OWNER_READ	Posix S_IRUSR: File owner has read permission.
OWNER_WRITE	Posix S_IWUSR: File owner has write permission.
OWNER_EXEC	Posix S_IXUSR: File owner has execute/search permission.
OWNER_ALL	Posix S_IRWXU: File owner has read, write, and execute/search permissions Equivalent to owner_read \| owner_write \| owner_exec.
GROUP_READ	Posix S_IRGRP: The file's user group has read permission.
GROUP_WRITE	Posix S_IWGRP: The file's user group has write permission.
GROUP_EXEC	Posix S_IXGRP: The file's user group has execute/search permission.
GROUP_ALL	Posix S_IRWXG: The file's user group has read, write, and execute/search permissions Equivalent to group_read \| group_write \| group_exec.
OTHERS_READ	Posix S_IROTH: Other users have read permission.
OTHERS_WRITE	Posix S_IWOTH: Other users have write permission.
OTHERS_EXEC	Posix S_IXOTH: Other users have execute/search permission.
OTHERS_ALL	Posix S_IRWXO: Other users have read, write, and execute/search permissions Equivalent to others_read \| others_write \| others_exec.
SET_UID	Posix S_ISUID: Set user ID to file owner user ID on execution.
SET_GID	Posix S_ISGID: Set group ID to file's user group ID on execution.
STICKY_BIT	Posix S_ISVTX: Implementation-defined meaning, but POSIX XSI specifies that when set on a directory, only file owners may delete files even if the directory is writeable to others (used with /tmp).

Definition at line 90 of file finfo.inl.

◆ ScanStates

enum class alib::files::FInfo::ScanStates : uint8_t

strong

Per-entry information about how a node was scanned.

Enumerator
NONE	Node created only from the given start path path.
STATS	Only stats (size, date, owner, etc.) read.
RESOLVED	Read symlink target strings.
MAX_DEPTH_REACHED	Scanning stopped because maximum depth was reached.
NOT_FOLLOWED	A symbolic link that targets a directory, but scan parameters specify not to follow.
NOT_CROSSING_FS	A directory that represented a mounted filesystem was not followed due to the field bool CrossFileSystems being set to `false`.
NO_AFS	A directory that represented a mounted filesystem was not followed due to the field bool IncludeArtificialFS being set to `false`.
RECURSIVE	Follow symlink target strings.
NO_ACCESS	Scanner failure due to limited access rights.
NO_ACCESS_SL	Scanner failure due to limited access rights on a symbolic link.
NO_ACCESS_SL_TARGET	Scanner failure due to limited access rights on a symbolic link's target.
NO_ACCESS_DIR	Scanner failure due to limited access rights on a directory.
BROKEN_LINK	A symbolic link targets a non-existent file or directory.
CIRCULAR_LINK	Set if recursion stopped at a symbolic link which was identified by the operating system as a circular link.
DUPLICATE	Set if recursion stopped on a symbolic link who's target had been scanned already. This might happen either because the path was already scanned by another search, or because a symbolic link is circular or because of a mixture of both. Thus, this can indicate a circular link, but does not have to.
NOT_EXISTENT	Set if a given start path does not exist.
UNKNOWN_ERROR	Unknown scanner failure.

Definition at line 124 of file finfo.inl.

◆ ScanStates3Letters

enum class alib::files::FInfo::ScanStates3Letters : uint8_t

strong

This is a resourced enumeration that is equivalent to enum class ScanStates but uses a 3-Letter code when serialized.

Enumerator
NONE	NON: Node created only from given start path path.
STATS	STA: Only stats (size, date, owner, etc.) read.
RESOLVED	RES: Read symlink target strings.
MAX_DEPTH_REACHED	MDR:Scanner stopped, because maximum depth was reached.
NOT_FOLLOWED	NFO:A symbolic link that targets a directory, but scan parameters specify not to follow.
NOT_CROSSING_FS	NCF:A directory that represented a mounted filesystem was not followed due to the field bool CrossFileSystems being set to `false`.
NO_AFS	NAF:A directory that represented a mounted filesystem was not followed due to the field bool IncludeArtificialFS being set to `false`.
RECURSIVE	REC:Follow symlink target strings.
NO_ACCESS	NAC: Scanner failure due to limited access rights.
NO_ACCESS_SL	NSL: Scanner failure due to limited access rights.
NO_ACCESS_SL_TARGET	NAT: Scanner failure due to limited access rights.
NO_ACCESS_DIR	NAD: Scanner failure due to limited access rights.
BROKEN_LINK	BRL: A symbolic link targets a non-existent file or directory.
CIRCULAR_LINK	operating system as a circular link. CIL: Set if recursion stopped on a symbolic link which was identified by the
DUPLICATE	DUP: Set if recursion stopped on a symbolic link who's target had been scanned already. This might happen either because the path was already scanned by another search, or because a symbolic link is circular or because of a mixture of both. Thus, this can indicate a circular link, but does not have to.
NOT_EXISTENT	NEX: Set if a given start path does not exist.
UNKNOWN_ERROR	UKE: Unknown scanner failure.

Definition at line 156 of file finfo.inl.

◆ TypeNames1Letter

enum class alib::files::FInfo::TypeNames1Letter : uint8_t

strong

This is a resourced enumeration that is equivalent to enum class Types but uses a 1-Letter code when serialized. The symbols are taken from GNU/Linux command 'ls -l', except special type SYMBOLIC_LINK_DIR which uses an upper case 'L' in contrast to the lower case 'l' used with links to files.

Enumerator
DIRECTORY	d: Directory/folder.
SYMBOLIC_LINK_DIR	L: Symbolic link targeting a directory.
REGULAR	-: Regular file.
SYMBOLIC_LINK	l: Symbolic link targeting a non-directory file.
BLOCK	b: A block special file.
CHARACTER	c: A character special file.
FIFO	p: A FIFO (also known as pipe) file.
SOCKET	s: A socket file.

Definition at line 48 of file finfo.inl.

◆ TypeNames2Letters

enum class alib::files::FInfo::TypeNames2Letters : uint8_t

strong

This is a resourced enumeration that is equivalent to enum class Types but uses a 2-Letter code when serialized.

Enumerator
DIRECTORY	DR: Directory/folder.
SYMBOLIC_LINK_DIR	LD: Symbolic link targeting a directory.
REGULAR	RF: Regular file.
SYMBOLIC_LINK	LF: Symbolic link targeting a non-directory file.
BLOCK	BL: A block special file.
CHARACTER	CH: A character special file.
FIFO	FF: A FIFO (also known as pipe) file.
SOCKET	SO: A socket file.

Definition at line 62 of file finfo.inl.

◆ TypeNames3Letters

enum class alib::files::FInfo::TypeNames3Letters : uint8_t

strong

This is a resourced enumeration that is equivalent to enum class Types but uses a 3-Letter code when serialized.

Enumerator
DIRECTORY	DIR: Directory/folder.
SYMBOLIC_LINK_DIR	SLD: Symbolic link targeting a directory.
REGULAR	REG: Regular file.
SYMBOLIC_LINK	SLF: Symbolic link targeting a non-directory file.
BLOCK	BLK: A block special file.
CHARACTER	CHR: A character special file.
FIFO	FFO: A FIFO (also known as pipe) file.
SOCKET	SCK: A socket file.

Definition at line 76 of file finfo.inl.

◆ Types

enum class alib::files::FInfo::Types : uint8_t

strong

Enumeration of the possible file types. This is compatible with the posix list of types, with the exception that symbolic links are differentiated between those linking to a directory and those linking to any other file type.

Enumerator
DIRECTORY	Directory/folder.
SYMBOLIC_LINK_DIR	Symbolic link targeting a directory. In case scanning does not resolve links, this is never set.
REGULAR	Regular file.
SYMBOLIC_LINK	Symbolic link targeting a non-directory file. In case scanning does not resolve links, possibly to a directory.
BLOCK	A block special file.
CHARACTER	A character special file.
FIFO	A FIFO (also known as pipe) file.
SOCKET	A socket file.
UNKNOWN_OR_ERROR	Filetype (should never or seldom happen). Maybe filesystem changed during scan or similar strange thing.
MARKER_TYPES_END	A marker for the last countable type. The rest are unused/errors.

Definition at line 26 of file finfo.inl.

Field Details:

◆ aDate

DateTime alib::files::FInfo::aDate

protected

The date of last read or write access. This is not correctly set on all platforms/filesystems. If not available, it will be set to mDate.

Definition at line 327 of file finfo.inl.

◆ bDate

DateTime alib::files::FInfo::bDate

protected

The date this file was created. This timestamp is correctly set only with certain filesystems under GNU/Linux, e.g., 'EXT4'. If not available, the smallest value of the other three timestamps is used.

Definition at line 320 of file finfo.inl.

◆ bits

Bits alib::files::FInfo::bits

protected

A bitfield encoding various information.

Definition at line 359 of file finfo.inl.

◆ cDate

DateTime alib::files::FInfo::cDate

protected

The date of the last change of the files' meta-information (e.g., owner). This is not correctly set on all platforms/filesystems. If not available, it will be set to mDate.

Definition at line 324 of file finfo.inl.

◆ custom

void* alib::files::FInfo::custom = nullptr

protected

Pool-allocated custom data.

Definition at line 365 of file finfo.inl.

◆ dbgCustomType

const std::type_info* alib::files::FInfo::dbgCustomType = nullptr

protected

The custom type attached. Used for asserting misuse in debug-compilations.

Definition at line 369 of file finfo.inl.

◆ extendedInfo

ExtendedEntryInfo* alib::files::FInfo::extendedInfo = nullptr

protected

Extended information, depending on the entry type.

Definition at line 362 of file finfo.inl.

◆ group

uint32_t alib::files::FInfo::group

protected

The group id that owns the file.

Definition at line 334 of file finfo.inl.

◆ mDate

DateTime alib::files::FInfo::mDate

protected

The last date and time the contents of the file was modified. This timestamp is should be correct on all platforms/filesystems.

Definition at line 318 of file finfo.inl.

◆ owner

uint32_t alib::files::FInfo::owner

protected

The user id that owns the file.

Definition at line 333 of file finfo.inl.

◆ qtyHardLinks

uint32_t alib::files::FInfo::qtyHardLinks

protected

The number of hard links to the file.

Definition at line 335 of file finfo.inl.

◆ size

uinteger alib::files::FInfo::size

protected

The file size. In case of a directory, this is 0.

Definition at line 332 of file finfo.inl.

◆ symParent

uinteger alib::files::FInfo::symParent = 0

protected

A cursor handle to the symbolic parent. See manual chapter 2.3 Real-Paths for more information.

Definition at line 330 of file finfo.inl.

◆ UnknownID

TOwnerAndGroupID alib::files::FInfo::UnknownID = (std::numeric_limits<uint32_t>::max)()

staticconstexpr

Constant value for owner and group IDs to denote that the field was not determined.

Definition at line 121 of file finfo.inl.

Method Details:

◆ ADate()

DateTime alib::files::FInfo::ADate ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the timestamp of last access to this file/folder. If unavailable, same as MDate.

Definition at line 402 of file finfo.inl.

◆ BDate()

DateTime alib::files::FInfo::BDate ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the birth date of this file/folder.

Definition at line 398 of file finfo.inl.

◆ CDate()

DateTime alib::files::FInfo::CDate ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the change date of this file/folder. If unavailable, same as MDate.

Definition at line 400 of file finfo.inl.

◆ GetExtendedInfo()

ExtendedEntryInfo * alib::files::FInfo::GetExtendedInfo ( ) const

inlinenodiscardconstexpr

Retrieves the extended info object of this entry.

Returns: The extended info object of this entry. If not available nullptr is returned.

Definition at line 412 of file finfo.inl.

◆ GetLinkTarget()

system::CPathString & alib::files::FInfo::GetLinkTarget ( ) const

inlinenodiscardnoexcept

Retrieves the non-translated target of a symbolic link. In debug compilations, the method asserts that Type returns either SYMBOLIC_LINK or SYMBOLIC_LINK_DIR.

Returns: A reference to a copy of the zero-terminated string stored in the symbolic link file.

Definition at line 461 of file finfo.inl.

◆ GetRealLinkTarget()

system::CPathString & alib::files::FInfo::GetRealLinkTarget ( ) const

inlinenodiscardnoexcept

Retrieves the resolved target of a symbolic link. In debug compilations, the method asserts that Type returns either SYMBOLIC_LINK or SYMBOLIC_LINK_DIR.

Returns: A reference to a zero-terminated string giving the translated real path that a symbolic link points to.

Definition at line 473 of file finfo.inl.

◆ Group()

uint32_t alib::files::FInfo::Group ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the ID of the group of the file/folder if available. Otherwise set to UnknownID.

Definition at line 406 of file finfo.inl.

◆ IsArtificialFS()

bool alib::files::FInfo::IsArtificialFS ( ) const

inlinenodiscardconstexprnoexcept

Returns: Returns true if the entry resides on an artificial filesystem.

Definition at line 386 of file finfo.inl.

◆ IsCrossingFS()

bool alib::files::FInfo::IsCrossingFS ( ) const

inlinenodiscardconstexprnoexcept

Returns: Returns true if the entry resides on a different filesystem than it's parent.

Definition at line 390 of file finfo.inl.

◆ IsDirectory()

bool alib::files::FInfo::IsDirectory ( ) const

inlinenodiscardconstexprnoexcept

Returns: Checks type for being either directory or symbolic link pointing to one.

Definition at line 379 of file finfo.inl.

◆ IsSymbolicLink()

bool alib::files::FInfo::IsSymbolicLink ( ) const

inlinenodiscardconstexprnoexcept

Returns: Checks type for being a symbolic link (to normal file or to a directory).

Definition at line 381 of file finfo.inl.

◆ MDate()

DateTime alib::files::FInfo::MDate ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the last modification date of this file/folder.

Definition at line 396 of file finfo.inl.

◆ Owner()

uint32_t alib::files::FInfo::Owner ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the ID of the owner of the file/folder if available. Otherwise set to UnknownID.

Definition at line 404 of file finfo.inl.

◆ Perms()

Permissions alib::files::FInfo::Perms ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the permissions of the entry.

Definition at line 375 of file finfo.inl.

◆ QtyHardLinks()

uint32_t alib::files::FInfo::QtyHardLinks ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the number of hard links pointing to this file if available. Otherwise set to UnknownID.

Definition at line 408 of file finfo.inl.

◆ ScanState()

ScanStates alib::files::FInfo::ScanState ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the scan sate of the entry.

Definition at line 384 of file finfo.inl.

◆ SetADate()

void alib::files::FInfo::SetADate ( DateTime v )

inlinenoexcept

Sets the time of last access of this file/folder.

Parameters

v	The value to set.

Definition at line 523 of file finfo.inl.

◆ SetArtificialFS()

void alib::files::FInfo::SetArtificialFS ( )

inlinenoexcept

Mark the entry as residing on an artificial filesystem.

Definition at line 494 of file finfo.inl.

◆ SetBDate()

void alib::files::FInfo::SetBDate ( DateTime v )

inlinenoexcept

Sets the birth date of this file/folder.

Parameters

v	The value to set.

Definition at line 515 of file finfo.inl.

◆ SetCDate()

void alib::files::FInfo::SetCDate ( DateTime v )

inlinenoexcept

Sets the change date of this file/folder.

Parameters

v	The value to set.

Definition at line 519 of file finfo.inl.

◆ SetCrossingFS()

void alib::files::FInfo::SetCrossingFS ( )

inlinenoexcept

Mark the entry as residing on a different filesystem than its parent.

Definition at line 500 of file finfo.inl.

◆ SetExtendedInfo()

void alib::files::FInfo::SetExtendedInfo ( ExtendedEntryInfo * extInfo )

inlineconstexpr

Sets the extended information object. As with all set functions, this method should only be used from certain code entities, like file scanners. If used, the object passed here has to be pool-allocated using public instance PoolAllocator Pool. The object will be freed with the deletion of the corresponding string tree node (respectively File instance).

Parameters

extInfo A pointer to the information object to use.

Definition at line 420 of file finfo.inl.

◆ SetGroup()

void alib::files::FInfo::SetGroup ( uint32_t v )

inlinenoexcept

Sets the ID of the group of the file/folder.

Parameters

v	The value to set.

Definition at line 531 of file finfo.inl.

◆ SetLinkTarget()

void alib::files::FInfo::SetLinkTarget	(	FTree &	tree,
		const system::PathString &	target,
		const system::PathString &	realTarget )

Stores the link targets in the extended information object created for symbolic links.

Parameters

tree	The tree that this object belongs to.
target	The target as stored in the symlink
realTarget	The translated, 'real' target path (if not broken).

Definition at line 42 of file finfo.cpp.

◆ SetMDate()

void alib::files::FInfo::SetMDate ( DateTime v )

inlinenoexcept

Sets the last modification date of this file/folder.

Parameters

v	The value to set.

Definition at line 511 of file finfo.inl.

◆ SetOwner()

void alib::files::FInfo::SetOwner ( uint32_t v )

inlinenoexcept

Sets the ID of the owner of the file/folder.

Parameters

v	The value to set.

Definition at line 527 of file finfo.inl.

◆ SetPerms()

void alib::files::FInfo::SetPerms ( Permissions v )

inlinenoexcept

Sets the permissions of the entry.

Parameters

v	The value to set.

Definition at line 483 of file finfo.inl.

◆ SetQtyHardlinks()

void alib::files::FInfo::SetQtyHardlinks ( uint32_t v )

inlinenoexcept

Sets the number of hard links that point to this file.

Parameters

v	The value to set.

Definition at line 535 of file finfo.inl.

◆ SetScanState()

void alib::files::FInfo::SetScanState ( ScanStates v )

inlinenoexcept

Sets the state of scan of the entry.

Parameters

v	The value to set.

Definition at line 491 of file finfo.inl.

◆ SetSize()

void alib::files::FInfo::SetSize ( uinteger v )

inlinenoexcept

Sets the file size.

Parameters

v	The value to set.

Definition at line 507 of file finfo.inl.

◆ SetSums()

void alib::files::FInfo::SetSums ( const DirectorySums & sums ) const

inlineconstexpr

Sets the sums of the extended info object of this entry.

Parameters

sums	The sums to set.

Definition at line 438 of file finfo.inl.

◆ SetTargetArtificialFS()

void alib::files::FInfo::SetTargetArtificialFS ( )

inlinenoexcept

Mark the entry as a symlink who's target is residing on an artificial filesystem.

Definition at line 497 of file finfo.inl.

◆ SetTargetCrossingFS()

void alib::files::FInfo::SetTargetCrossingFS ( )

inlinenoexcept

Mark the entry as a symlink who's target is residing in a different filesystem than the symlink.

Definition at line 503 of file finfo.inl.

◆ SetType()

void alib::files::FInfo::SetType ( Types v )

inlinenoexcept

Sets the type of the entry.

Parameters

v	The value to set.

Definition at line 487 of file finfo.inl.

◆ Size()

uinteger alib::files::FInfo::Size ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the file size.

Definition at line 394 of file finfo.inl.

◆ Sums()

DirectorySums & alib::files::FInfo::Sums ( ) const

inlinenodiscardconstexpr

Retrieves the directory sums of this directory or symbolic link to directory.

Returns: A reference to the sums.

Definition at line 424 of file finfo.inl.

◆ TargetIsArtificialFS()

bool alib::files::FInfo::TargetIsArtificialFS ( ) const

inlinenodiscardconstexprnoexcept

Returns: Returns true if the entry is a symlink and its target resides on an artificial filesystem.

Definition at line 388 of file finfo.inl.

◆ TargetIsCrossingFS()

bool alib::files::FInfo::TargetIsCrossingFS ( ) const

inlinenodiscardconstexprnoexcept

Returns: Returns true if the entry is a symlink and resides on a different filesystem than the link.

Definition at line 392 of file finfo.inl.

◆ Type()

Types alib::files::FInfo::Type ( ) const

inlinenodiscardconstexprnoexcept

Returns: Retrieves the type of the entry

Definition at line 377 of file finfo.inl.

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

Description:

Inner Type Index:

Public Type Index:

Public Static Field Index:

Public Method Index:

Protected Field Index:

Type Definition Details:

◆ TOwnerAndGroupID

Enumeration Details:

◆ Permissions

◆ ScanStates

◆ ScanStates3Letters

◆ TypeNames1Letter

◆ TypeNames2Letters

◆ TypeNames3Letters

◆ Types

Field Details:

◆ aDate

◆ bDate

◆ bits

◆ cDate

◆ custom

◆ dbgCustomType

◆ extendedInfo

◆ group

◆ mDate

◆ owner

◆ qtyHardLinks

◆ size

◆ symParent

◆ UnknownID

Method Details:

◆ ADate()

◆ BDate()

◆ CDate()

◆ GetExtendedInfo()

◆ GetLinkTarget()

◆ GetRealLinkTarget()

◆ Group()

◆ IsArtificialFS()

◆ IsCrossingFS()

◆ IsDirectory()

◆ IsSymbolicLink()

◆ MDate()

◆ Owner()

◆ Perms()

◆ QtyHardLinks()

◆ ScanState()

◆ SetADate()

◆ SetArtificialFS()

◆ SetBDate()

◆ SetCDate()

◆ SetCrossingFS()

◆ SetExtendedInfo()

◆ SetGroup()

◆ SetLinkTarget()

◆ SetMDate()

◆ SetOwner()

◆ SetPerms()

◆ SetQtyHardlinks()

◆ SetScanState()

◆ SetSize()

◆ SetSums()

◆ SetTargetArtificialFS()

◆ SetTargetCrossingFS()

◆ SetType()

◆ Size()

◆ Sums()

◆ TargetIsArtificialFS()

◆ TargetIsCrossingFS()

◆ Type()