alib::files::FInfo::DirectorySums Struct Reference

Description:

Recursively accumulated values for directories.

Definition at line 188 of file finfo.inl.

Public Field Index:
uint32_t	QtyErrsAccess = 0
	Number of access errors in the folder and subfolders.
uint32_t	QtyErrsBrokenLink = 0
	Number of broken symbolic links in the directory and its subfolders.
uint32_t	QtyStopsOnCircularLinks = 0
	Number of recursion aborts due to detected circular links reach of maximum recursion depth.
uint32_t	QtyStopsOnMaxDepth = 0
	Number of recursion aborts due to reach of maximum recursion depth.
uinteger	Size = 0
	The cumulated sizes of all files and directories.
std::array< uint32_t, size_t(Types::MARKER_TYPES_END)>	TypeCounters = {0,0,0,0,0,0,0,0}
	Per-type counters.

Public Method Index:
constexpr	DirectorySums () noexcept=default
	Defaulted default constructor.
constexpr DirectorySums &	Add (const FInfo &finfo) noexcept
uint32_t	Count () const noexcept
uint32_t	Count (Types type) const noexcept
uint32_t	CountDirectories () const noexcept
uint32_t	CountNonDirectories () const noexcept
constexpr bool	IsDirType (Types type) const noexcept
DirectorySums &	operator+= (const DirectorySums &rhs)
DirectorySums &	operator-= (const DirectorySums &rhs)

Field Details:

QtyErrsAccess

uint32_t alib::files::FInfo::DirectorySums::QtyErrsAccess = 0

Number of access errors in the folder and subfolders.

Definition at line 192 of file finfo.inl.

QtyErrsBrokenLink

uint32_t alib::files::FInfo::DirectorySums::QtyErrsBrokenLink = 0

Number of broken symbolic links in the directory and its subfolders.

Definition at line 193 of file finfo.inl.

QtyStopsOnCircularLinks

uint32_t alib::files::FInfo::DirectorySums::QtyStopsOnCircularLinks = 0

Number of recursion aborts due to detected circular links reach of maximum recursion depth.

Definition at line 195 of file finfo.inl.

QtyStopsOnMaxDepth

uint32_t alib::files::FInfo::DirectorySums::QtyStopsOnMaxDepth = 0

Number of recursion aborts due to reach of maximum recursion depth.

Definition at line 194 of file finfo.inl.

Size

uinteger alib::files::FInfo::DirectorySums::Size = 0

The cumulated sizes of all files and directories.

Definition at line 190 of file finfo.inl.

TypeCounters

std::array<uint32_t, size_t(Types::MARKER_TYPES_END)> alib::files::FInfo::DirectorySums::TypeCounters = {0,0,0,0,0,0,0,0}

Per-type counters.

Definition at line 191 of file finfo.inl.

Method Details:

Add()

DirectorySums & alib::files::FInfo::DirectorySums::Add ( const FInfo & finfo )

inlineconstexprnoexcept

Adds a file/directory to the counters

Parameters

finfo

The entry to add.

Returns

A reference to this

Definition at line 241 of file finfo.inl.

Count() [1/2]

uint32_t alib::files::FInfo::DirectorySums::Count ( ) const

inlinenoexcept

Returns the cumulated number of entries (of any type).

Returns

The number of entries counted.

Definition at line 250 of file finfo.inl.

Count() [2/2]

uint32_t alib::files::FInfo::DirectorySums::Count ( Types type ) const

inlinenoexcept

Returns the number of entries of the given type.

Parameters

type	The type to get the number of entries for.

Returns

The number of directories or symbolic links to directories.

Definition at line 260 of file finfo.inl.

CountDirectories()

uint32_t alib::files::FInfo::DirectorySums::CountDirectories ( ) const

inlinenoexcept

Returns the sum of the number of entries of type DIRECTORY and SYMBOLIC_LINK_DIR

Returns

The number of directories or symbolic links to directories.

Definition at line 270 of file finfo.inl.

CountNonDirectories()

uint32_t alib::files::FInfo::DirectorySums::CountNonDirectories ( ) const

inlinenoexcept

Returns the sum of the number of entries which are not of type DIRECTORY and SYMBOLIC_LINK_DIR

Returns

The number of regular files, fifo, sockets, etc.

Definition at line 279 of file finfo.inl.

IsDirType()

bool alib::files::FInfo::DirectorySums::IsDirType ( Types type ) const

inlineconstexprnoexcept

Returns true if the given type equals either DIRECTORY or SYMBOLIC_LINK_DIR

Parameters

type	returns false if the given type does not represent a directory and true if type equals DIRECTORY or SYMBOLIC_LINK_DIR

Returns

false if the given type does not represent a directory, true otherwise.

Definition at line 236 of file finfo.inl.

operator+=()

DirectorySums & alib::files::FInfo::DirectorySums::operator+= ( const DirectorySums & rhs )

inline

Adds the values in the given summary object to this.

Parameters

rhs	The values to add.

Returns

A reference to this

Definition at line 204 of file finfo.inl.

operator-=()

DirectorySums & alib::files::FInfo::DirectorySums::operator-= ( const DirectorySums & rhs )

inline

Subtracts the values in the given summary object from this.

Parameters

rhs	The values to subtract.

Returns

A reference to this

Definition at line 218 of file finfo.inl.

---

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

• finfo.inl