Filesystem
[Utilities]

Files
file	dir_iterator.hh
file	fs_entry-fwd.hh
file	fs_entry.hh
file	is_file_with_extension.hh
file	safe_ifstream-fwd.hh
file	safe_ifstream.hh
file	safe_ofstream.hh
Classes
class	paludis::DirOpenError
class	paludis::DirIterator
class	paludis::FSError
class	paludis::FSEntry
class	paludis::SafeIFStreamBuf
class	paludis::SafeIFStreamBase
class	paludis::SafeIFStream
class	paludis::SafeIFStreamError
class	paludis::SafeOFStreamBuf
class	paludis::SafeOFStreamBase
class	paludis::SafeOFStream
class	paludis::SafeOFStreamError
Typedefs
typedef Sequence< FSEntry >	paludis::FSEntrySequence
typedef Set< FSEntry >	paludis::FSEntrySet
typedef Options< IsFileWithOption >	paludis::IsFileWithOptions
Enumerations
enum	paludis::DirIteratorOption { paludis::dio_include_dotfiles, paludis::dio_inode_sort, paludis::dio_first_only, paludis::last_dio }
enum	paludis::FSPermission { paludis::fs_perm_read, paludis::fs_perm_write, paludis::fs_perm_execute }
enum	paludis::FSUserGroup { paludis::fs_ug_owner, paludis::fs_ug_group, paludis::fs_ug_others }
enum	paludis::IsFileWithOption { paludis::ifwo_no_follow_symlinks, paludis::last_ifwo }
Functions
std::ostream &	paludis::operator<< (std::ostream &s, const FSEntry &f) PALUDIS_VISIBLE
bool	paludis::is_file_with_extension (const FSEntry &, const std::string &, const IsFileWithOptions &) PALUDIS_VISIBLE
bool	paludis::is_file_with_prefix_extension (const FSEntry &, const std::string &, const std::string &, const IsFileWithOptions &) PALUDIS_VISIBLE

---

Detailed Description

We provide various functions and classes that simplify various common filesystem operations.

Examples

• None at this time.

---

Typedef Documentation

typedef Sequence<FSEntry> paludis::FSEntrySequence

A sequence of FSEntry instances.

typedef Set<FSEntry> paludis::FSEntrySet

A set of FSEntry instances.

typedef Options<IsFileWithOption> paludis::IsFileWithOptions

Options for is_file_with_prefix_extension() and is_file_with_extension().

See also:

IsFileWithOption

is_file_with_prefix_extension

is_file_with_extension

---

Enumeration Type Documentation

enum paludis::DirIteratorOption

Options for a DirIterator.

See also:

DirIterator

DirIteratorOptions

Enumerator:

dio_include_dotfiles	Skip files whose name start with a dot.
dio_inode_sort	Return items sorted by inode number.
dio_first_only	Return the first item only.
last_dio	Number of keys in paludis::DirIteratorOption.

enum paludis::FSPermission

File permissions used by FSEntry.

Enumerator:

fs_perm_read	read permission on file
fs_perm_write	write permission on file
fs_perm_execute	execute permission on file

enum paludis::FSUserGroup

User classes used by FSEntry.

Enumerator:

fs_ug_owner	owner permission
fs_ug_group	group permission
fs_ug_others	others permission

enum paludis::IsFileWithOption

Options for is_file_with_extension() and is_file_with_prefix_extension().

See also:

IsFileWithOptions

is_file_with_extension()

is_file_with_prefix_extension()

Enumerator:

ifwo_no_follow_symlinks	Do not follow symlinks.
last_ifwo	Number of keys in paludis::IsFileWithOption.

---

Function Documentation

bool paludis::is_file_with_extension	(	const FSEntry &	,
		const std::string &	,
		const IsFileWithOptions &
	)

Return whether an FSEntry is a file with a given extension.

See also:

is_file_with_prefix_extension()

bool paludis::is_file_with_prefix_extension	(	const FSEntry &	,
		const std::string &	,
		const std::string &	,
		const IsFileWithOptions &
	)

Return whether an FSEntry is a file with a given prefix and a given extension prefix.

See also:

is_file_with_extension()

std::ostream& paludis::operator<<	(	std::ostream &	s,
		const FSEntry &	f
	)

An FSEntry can be written to an ostream.

---