limes::files::volume Namespace Reference

This namespace contains free functions for easily querying properties of the volume that the current working directory is mounted on. More...

Functions
LFILE_EXPORT std::uintmax_t	bytesFree ()
	Returns the number of bytes free on the current volume. More...
LFILE_EXPORT bool	caseSensitive ()
	Returns true if the current volume is case-sensitive. More...
LFILE_EXPORT std::string	label ()
	Returns the current volume's label. More...
LFILE_EXPORT bool	readOnly ()
	Returns true if the current volume is mounted as read-only. More...
LFILE_EXPORT int	serialNumber ()
	Returns the current volume's serial number. More...
LFILE_EXPORT std::uintmax_t	totalBytes ()
	Returns the total number of bytes on the current volume. More...
LFILE_EXPORT Volume::Type	type ()
	Returns the type of the current volume. More...

Detailed Description

This namespace contains free functions for easily querying properties of the volume that the current working directory is mounted on.

The advantage of these functions is that if the current volume cannot be successfully queried, they fall back to sensible defaults. If you need to know whether the actual volume can be queried, you can call Volume::tryCreate() .

Function Documentation

bytesFree()

LFILE_EXPORT std::uintmax_t limes::files::volume::bytesFree

(

)

Returns the number of bytes free on the current volume.

See also

Volume::bytesFree()

caseSensitive()

LFILE_EXPORT bool limes::files::volume::caseSensitive

(

)

Returns true if the current volume is case-sensitive.

See also

Volume::isCaseSensitive(), filesystemIsCaseSensitive()

label()

LFILE_EXPORT std::string limes::files::volume::label

(

)

Returns the current volume's label.

See also

Volume::getLabel()

readOnly()

LFILE_EXPORT bool limes::files::volume::readOnly

(

)

Returns true if the current volume is mounted as read-only.

See also

Volume::isReadOnly()

serialNumber()

LFILE_EXPORT int limes::files::volume::serialNumber

(

)

Returns the current volume's serial number.

See also

Volume::getSerialNumber()

totalBytes()

LFILE_EXPORT std::uintmax_t limes::files::volume::totalBytes

(

)

Returns the total number of bytes on the current volume.

See also

Volume::totalBytes()

type()

LFILE_EXPORT Volume::Type limes::files::volume::type

(

)

Returns the type of the current volume.

See also

Volume::getType()