paludis  Version 2.6.0
Files | Classes | Typedefs | Enumerations | Functions
Filesystem

Files

file  is_file_with_extension.hh
 
file  safe_ifstream-fwd.hh
 
file  safe_ifstream.hh
 
file  safe_ofstream.hh
 

Classes

class  paludis::FSError
 
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 Options< IsFileWithOptionpaludis::IsFileWithOptions
 

Enumerations

enum  paludis::FSIteratorOption {
  paludis::fsio_include_dotfiles, paludis::fsio_inode_sort, paludis::fsio_first_only, paludis::fsio_want_directories,
  paludis::fsio_want_regular_files, paludis::fsio_deref_symlinks_for_wants, paludis::last_fsio
}
 
enum  FSIteratorOption {
  fsio_include_dotfiles, fsio_inode_sort, fsio_first_only, fsio_want_directories,
  fsio_want_regular_files, fsio_deref_symlinks_for_wants, last_fsio
}
 
enum  paludis::FSPathMkdirOption { paludis::fspmkdo_ok_if_exists, paludis::last_fspmkdo }
 
enum  FSPathMkdirOption { fspmkdo_ok_if_exists, last_fspmkdo }
 
enum  IsFileWithOption { ifwo_no_follow_symlinks, last_ifwo }
 
enum  paludis::IsFileWithOption { paludis::ifwo_no_follow_symlinks, paludis::last_ifwo }
 

Functions

std::ostream & paludis::operator<< (std::ostream &s, const FSPath &f) PALUDIS_VISIBLE
 
bool paludis::is_file_with_extension (const FSPath &, const std::string &, const IsFileWithOptions &) PALUDIS_VISIBLE
 
bool paludis::is_file_with_prefix_extension (const FSPath &, 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

Typedef Documentation

Enumeration Type Documentation

Options for an FSIterator.

If no fsio_want_ options are specified, all entries are always returned. Otherwise, entries will be skipped if their type is not any of the fsio_want_ types.

See also
FSIterator
FSIteratorOptions
Enumerator
fsio_include_dotfiles 

Skip files whose name start with a dot.

fsio_inode_sort 

Return items sorted by inode number.

fsio_first_only 

Return the first item only.

fsio_want_directories 
Since
0.54.1 We want directories
fsio_want_regular_files 
Since
0.54.1 We want regular files
fsio_deref_symlinks_for_wants 
Since
0.54.1 Dereference symlinks when determining wants
last_fsio 

Number of keys in paludis::FSIteratorOption.

Options for an FSIterator.

If no fsio_want_ options are specified, all entries are always returned. Otherwise, entries will be skipped if their type is not any of the fsio_want_ types.

See also
FSIterator
FSIteratorOptions
Enumerator
fsio_include_dotfiles 

Skip files whose name start with a dot.

fsio_inode_sort 

Return items sorted by inode number.

fsio_first_only 

Return the first item only.

fsio_want_directories 
Since
0.54.1 We want directories
fsio_want_regular_files 
Since
0.54.1 We want regular files
fsio_deref_symlinks_for_wants 
Since
0.54.1 Dereference symlinks when determining wants
last_fsio 

Number of keys in paludis::FSIteratorOption.

Options for FSPath::mkdir.

See also
FSPath::mkdir
FSPathMkdirOptions
Enumerator
fspmkdo_ok_if_exists 

It's ok if we already exist and are a directory.

last_fspmkdo 

Number of keys in paludis::FSPathMkdirOption.

Options for FSPath::mkdir.

See also
FSPath::mkdir
FSPathMkdirOptions
Enumerator
fspmkdo_ok_if_exists 

It's ok if we already exist and are a directory.

last_fspmkdo 

Number of keys in paludis::FSPathMkdirOption.

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.

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 FSPath ,
const std::string &  ,
const IsFileWithOptions  
)

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

See also
is_file_with_prefix_extension()
bool paludis::is_file_with_prefix_extension ( const FSPath ,
const std::string &  ,
const std::string &  ,
const IsFileWithOptions  
)

Return whether an FSPath 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 FSPath f 
)

An FSPath can be written to an ostream.