Types

• using path = basic_path< char >

  Specialisation of basic_path for char.

• template <class T>
using odirtree_iterator = basic_ostream_iterator< odirtree, T >

  Directory entry output stream iterator.

• using odirtree = basic_odirtree< copy_recursively >

  Directory entry output stream that copies all files and directories recursively.

• template <class Trans>
using basic_odirtree = basic_odirectory< Trans >

  The same template as basic_odirectory.

• template <class T>
using odirectory_iterator = basic_ostream_iterator< odirectory, T >

  Directory entry output stream iterator.

• using odirectory = basic_odirectory< copy_verbatim >

  Directory entry output stream that copies all files verbatim.

• template <class T>
using idirtree_iterator = basic_istream_iterator< idirtree, T >

  Recursive directory entry input stream iterator.

• using idirtree = basic_idirtree< ignore_hidden_files, ignore_hidden_dirs >

  Recursive directory entry input stream that ignores all hidden files during traversal and does not recurse to hidden directories.

• template <class T>
using idirectory_iterator = basic_istream_iterator< idirectory, T >

  Directory entry input stream iterator.

• using idirectory = basic_idirectory< ignore_hidden_files >

  Directory entry input stream that ignores all hidden files during traversal.

• using canonical_path = basic_canonical_path< char >

  Specialisation of basic_canonical_path for char.

Enumerations

• enum file_type: mode_type

  File types.

Classes

• template <class Ch, class Tr = std::char_traits<Ch>, class Alloc = std::allocator<Ch>>
class sys::basic_canonical_path

  Canonical path that is always absolute and real.

  Ch

  character type

  
  

  Tr

  character traits type

  
  

  Alloc

  allocator type

  
  

  Canonical path is a path that
  • contains no special directories "." and "..",
  • contains only one separator per component,
  • contains no symbolic links.

  Date

  2018-05-25

• template <class FilePred, class Trans>
class sys::basic_directory

  Directory entry input/output stream.

  FilePred

  file predicate type, that determines which directory entries to include in the stream.

  
  

  Trans

  transformation function type

  
  

  Date

  2018-05-25

• class sys::directory_entry

  Directory entry. A wrapper around dirent system type.

  Date

  2018-05-25

  See

  readdir(3)

• class sys::dirstream

  Base class for all directory streams. The class stores stream state similar to std::ios_base class for use in subclasses.

  Date

  2018-05-25

• class sys::file_mode

  File mode wrapper. A class that gives access to file mode bits via its methods.

  Date

  2018-05-25

• class sys::file_mutex

  File-based mutex.

  • Uses the sanest (but not very portable) flock(2) system call for file locking.
  • Read locks may be acquired by multiple processes, provided that there no write lock on the file.
  • Write lock may be acquired by only one process.

  Date

  2018-05-21

  See

  flock(2)

• class sys::file_status

  File status class that wraps stat system type.

  Date

  2018-05-25

• template <class FilePred>
class sys::basic_idirectory

  Directory entry input stream.

  FilePred

  file predicate type, that determines which directory entries to include in the stream.

  
  

  An input stream from which directory entries are read non-recursively.
  • File predicate may have internal state.

  Date

  2018-05-25

  See

  directory_entry

• template <class FilePred, class DirPred>
class sys::basic_idirtree

  Recursive directory entry input stream.

  FilePred

  file predicate type, that determines which directory entries to include in the stream.

  
  

  DirPred

  directory predicate type, that determines which directories to recurse into.

  
  

  An input stream from which directories entries are read recursively.
  • File and directory predicates may have internal state.

  Date

  2018-05-25

  See

  directory_entry

• template <class Trans>
class sys::basic_odirectory

  Directory entry output stream.

  Trans

  transformation function type

  
  

  An output stream to which directory entries are written.
  • Files are copied to output directory on insertion to the stream.

  Date

  2018-05-25

  See

  directory_entry

  See

  copy_file

• template <class Ch, class Tr = std::char_traits<Ch>, class Alloc = std::allocator<Ch>>
class sys::basic_path

  File system path template which is a std::string with additional methods.

  Ch

  character type

  
  

  Tr

  character traits type

  
  

  Alloc

  allocator type

  
  

  Date

  2018-05-25

Structs

• struct sys::ignore_hidden_files

  Do not include hidden file when traversing directories. This is the default file predicate for idirectory.

  Date

  2018-05-25

• struct sys::ignore_hidden_dirs

  Do not recurse to hidden directories when traversing directories.

  • Default directory predicate for idirtree.
  • Caches file status, which is accessed with status method.
  • File status is updated only if file system does not return file type in directory_entry.

  Date

  2018-05-25

• struct sys::copy_recursively

  Copy files and directories recursively. This is the default file transformation type for odirtree.

Functions

• mkdirs(const path & root, const path & relative_path, file_mode m = 0755) -> void

  Make directories recursively.

  bad_call

  
  

  root

  path, relative to which directories are created

  
  

  relative_path

  path, components of which are created

  
  

  m

  file mode of directories to be created

  
  

  Create directories relative to root assuming that the root exists.

  Date

  2018-04-25

  See

  mkdir(2)

• mkdirs(path dir, file_mode m = 0755, path::size_type offset = 1) -> void

  Make directories recursively.

  bad_call

  
  

  dir

  path, components of which are created

  
  

  m

  file mode of directories to be created

  
  

  offset

  character offset in path name to start creating directories from

  
  

  Create directories assuming all path components that come before offset characters from the beginning of dir exist.

  Date

  2018-04-25

  See

  mkdir(2)

• copy_file(const path & src, const path & dest) -> void

  Copy file using the most optimal system call.

  bad_call

  
  

  • Uses copy_file_range(2) on newer kernels.
  • Uses sendfile(2) when available.
  • Otherwise, falls back to standard stream copying.

  Date

  2018-05-25

  See

  copy_file_range(2)

  See

  sendfile(2)

• workdir() -> sys::canonical_path

  Get canonical path to the working directory of the calling process.