logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

std::filesystem - ISO C++ 2017 namespace for File System library.

Author

       Generated automatically by Doxygen for libstdc++ from the source code.

                                                    libstdc++                              std::filesystem(3cxx)

Detailed Description

       ISO C++ 2017 namespace for File System library.

Name

       std::filesystem - ISO C++ 2017 namespace for File System library.

Synopsis

Classes
       class directory_entry
           The value type used by directory iterators.
       class directory_iterator
           Iterator type for traversing the entries in a single directory.
       class file_status
           Information about a file's type and permissions.
       class filesystem_error
           Exception type thrown by the Filesystem library.
       class path
           A filesystem path.
       class recursive_directory_iterator
           Iterator type for recursively traversing a directory hierarchy.
       struct space_info
           Information about free space on a disk.

   Typedefsusingfile_time_type = __file_clock::time_point
           The type used for file timestamps.

   Enumerations
       enum class copy_options : unsigned short { none, skip_existing, overwrite_existing, update_existing,
           recursive, copy_symlinks, skip_symlinks, directories_only, create_symlinks, create_hard_links }
           Bitmask type controlling effects of filesystem::copy
       enum class directory_options : unsigned char { none, follow_directory_symlink, skip_permission_denied }
           Bitmask type controlling directory iteration.
       enum class file_type : signed char { none, not_found, regular, directory, symlink, block, character,
           fifo, socket, unknown }
           Enumerated type representing the type of a file.
       enum class perm_options : unsigned { replace, add, remove, nofollow }
           Bitmask type controlling changes to permissions.
       enum class perms : unsigned { none, owner_read, owner_write, owner_exec, owner_all, group_read,
           group_write, group_exec, group_all, others_read, others_write, others_exec, others_all, all, set_uid,
           set_gid, sticky_bit, mask, unknown }
           Bitmask type representing file access permissions.

   Functionspathabsolute (const path &__p)
       pathabsolute (const path &__p, error_code &__ec)
       pathcanonical (const path &__p)
       pathcanonical (const path &__p, error_code &__ec)
       voidcopy (const path &__from, const path &__to)
       voidcopy (const path &__from, const path &__to, copy_options__options)
       voidcopy (const path &__from, const path &__to, copy_options__options, error_code &)
       voidcopy (const path &__from, const path &__to, error_code &__ec)
       bool copy_file (const path &__from, const path &__to)
       bool copy_file (const path &__from, const path &__to, copy_options__option)
       bool copy_file (const path &__from, const path &__to, copy_options__option, error_code &)
       bool copy_file (const path &__from, const path &__to, error_code &__ec)
       voidcopy_symlink (const path &__existing_symlink, const path &__new_symlink)
       voidcopy_symlink (const path &__existing_symlink, const path &__new_symlink, error_code &__ec) noexcept
       bool create_directories (const path &__p)
       bool create_directories (const path &__p, error_code &__ec)
       bool create_directory (const path &__p)
       bool create_directory (const path &__p, const path &__attributes)
       bool create_directory (const path &__p, const path &__attributes, error_code &__ec) noexcept
       bool create_directory (const path &__p, error_code &__ec) noexcept
       voidcreate_directory_symlink (const path &__to, const path &__new_symlink)
       voidcreate_directory_symlink (const path &__to, const path &__new_symlink, error_code &__ec) noexcept
       voidcreate_hard_link (const path &__to, const path &__new_hard_link)
       voidcreate_hard_link (const path &__to, const path &__new_hard_link, error_code &__ec) noexcept
       voidcreate_symlink (const path &__to, const path &__new_symlink)
       voidcreate_symlink (const path &__to, const path &__new_symlink, error_code &__ec) noexcept
       pathcurrent_path ()
       voidcurrent_path (const path &__p)
       voidcurrent_path (const path &__p, error_code &__ec) noexcept
       pathcurrent_path (error_code &__ec)
       bool equivalent (const path &__p1, const path &__p2)
       bool equivalent (const path &__p1, const path &__p2, error_code &__ec) noexcept
       bool exists (const path &__p)
       bool exists (const path &__p, error_code &__ec) noexcept
       bool exists (file_status) noexcept
       uintmax_t file_size (const path &)
       uintmax_t file_size (const path &, error_code &) noexcept
       uintmax_t hard_link_count (const path &)
       uintmax_t hard_link_count (const path &, error_code &) noexcept
       size_t hash_value (const path &__p) noexcept
       bool is_block_file (const path &__p)
       bool is_block_file (const path &__p, error_code &__ec) noexcept
       bool is_block_file (file_status__s) noexcept
       bool is_character_file (const path &__p)
       bool is_character_file (const path &__p, error_code &__ec) noexcept
       bool is_character_file (file_status__s) noexcept
       bool is_directory (const path &__p)
       bool is_directory (const path &__p, error_code &__ec) noexcept
       bool is_directory (file_status__s) noexcept
       bool is_empty (const path &__p)
       bool is_empty (const path &__p, error_code &__ec)
       bool is_fifo (const path &__p)
       bool is_fifo (const path &__p, error_code &__ec) noexcept
       bool is_fifo (file_status__s) noexcept
       bool is_other (const path &__p)
       bool is_other (const path &__p, error_code &__ec) noexcept
       bool is_other (file_status) noexcept
       bool is_regular_file (const path &__p)
       bool is_regular_file (const path &__p, error_code &__ec) noexcept
       bool is_regular_file (file_status) noexcept
       bool is_socket (const path &__p)
       bool is_socket (const path &__p, error_code &__ec) noexcept
       bool is_socket (file_status__s) noexcept
       bool is_symlink (const path &__p)
       bool is_symlink (const path &__p, error_code &__ec) noexcept
       bool is_symlink (file_status) noexcept
       file_time_typelast_write_time (const path &)
       file_time_typelast_write_time (const path &, error_code &) noexcept
       voidlast_write_time (const path &__p, file_time_type__new_time)
       voidlast_write_time (const path &__p, file_time_type__new_time, error_code &__ec) noexcept
       copy_options & operator&= (copy_options &__x, copy_options __y) noexcept
       constexpr copy_optionsoperator^ (copy_options __x, copy_options __y) noexcept
       copy_options & operator^= (copy_options &__x, copy_options __y) noexcept
       constexpr copy_optionsoperator| (copy_options __x, copy_options __y) noexcept
       copy_options & operator|= (copy_options &__x, copy_options __y) noexcept
       constexpr copy_optionsoperator~ (copy_options __x) noexcept
       voidpermissions (const path &, perms, perm_options, error_code &) noexcept
       voidpermissions (const path &__p, perms__prms, error_code &__ec) noexcept
       voidpermissions (const path &__p, perms__prms, perm_options__opts=perm_options::replace)
       pathproximate (const path &__p, const path &__base, error_code &__ec)
       pathproximate (const path &__p, const path &__base=current_path())
       pathproximate (const path &__p, error_code &__ec)
       pathread_symlink (const path &__p)
       pathread_symlink (const path &__p, error_code &__ec)
       pathrelative (const path &__p, const path &__base, error_code &__ec)
       pathrelative (const path &__p, const path &__base=current_path())
       pathrelative (const path &__p, error_code &__ec)
       bool remove (const path &, error_code &) noexcept
       bool remove (const path &__p)
       uintmax_t remove_all (const path &)
       uintmax_t remove_all (const path &, error_code &)
       voidrename (const path &__from, const path &__to)
       voidrename (const path &__from, const path &__to, error_code &__ec) noexcept
       voidresize_file (const path &__p, uintmax_t __size)
       voidresize_file (const path &__p, uintmax_t __size, error_code &__ec) noexcept
       space_infospace (const path &__p)
       space_infospace (const path &__p, error_code &__ec) noexcept
       file_statusstatus (const path &)
       file_statusstatus (const path &, error_code &) noexcept
       bool status_known (file_status) noexcept
       file_statussymlink_status (const path &)
       file_statussymlink_status (const path &, error_code &) noexcept
       pathtemp_directory_path ()
       pathtemp_directory_path (error_code &__ec)
       pathweakly_canonical (const path &__p)
       pathweakly_canonical (const path &__p, error_code &__ec)

           constexpr permsoperator| (perms __x, perms __y) noexcept
           constexpr permsoperator^ (perms __x, perms __y) noexcept
           constexpr permsoperator~ (perms __x) noexcept
           perms & operator&= (perms &__x, perms __y) noexcept
           perms & operator|= (perms &__x, perms __y) noexcept
           perms & operator^= (perms &__x, perms __y) noexcept

           constexpr perm_optionsoperator| (perm_options __x, perm_options __y) noexcept
           constexpr perm_optionsoperator^ (perm_options __x, perm_options __y) noexcept
           constexpr perm_optionsoperator~ (perm_options __x) noexcept
           perm_options & operator&= (perm_options &__x, perm_options __y) noexcept
           perm_options & operator|= (perm_options &__x, perm_options __y) noexcept
           perm_options & operator^= (perm_options &__x, perm_options __y) noexcept

           constexpr directory_optionsoperator| (directory_options __x, directory_options __y) noexcept
           constexpr directory_optionsoperator^ (directory_options __x, directory_options __y) noexcept
           constexpr directory_optionsoperator~ (directory_options __x) noexcept
           directory_options & operator&= (directory_options &__x, directory_options __y) noexcept
           directory_options & operator|= (directory_options &__x, directory_options __y) noexcept
           directory_options & operator^= (directory_options &__x, directory_options __y) noexcept

See Also