.TH "std::filesystem" 3cxx "Wed Jul 28 2021" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::filesystem \- ISO C++ 2017 namespace for File System library\&.  

.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fB__directory_iterator_proxy\fP"
.br
.RI "Proxy returned by post-increment on directory iterators\&. "
.ti -1c
.RI "class \fBdirectory_entry\fP"
.br
.RI "The value type used by directory iterators\&. "
.ti -1c
.RI "class \fBdirectory_iterator\fP"
.br
.RI "Iterator type for traversing the entries in a single directory\&. "
.ti -1c
.RI "class \fBfile_status\fP"
.br
.RI "Information about a file's type and permissions\&. "
.ti -1c
.RI "class \fBfilesystem_error\fP"
.br
.RI "Exception type thrown by the Filesystem library\&. "
.ti -1c
.RI "class \fBpath\fP"
.br
.RI "A filesystem path\&. "
.ti -1c
.RI "class \fBrecursive_directory_iterator\fP"
.br
.RI "Iterator type for recursively traversing a directory hierarchy\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "using \fBfile_time_type\fP = \fB__file_clock::time_point\fP"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum class \fBcopy_options\fP : unsigned short { \fBnone\fP, \fBskip_existing\fP, \fBoverwrite_existing\fP, \fBupdate_existing\fP, \fBrecursive\fP, \fBcopy_symlinks\fP, \fBskip_symlinks\fP, \fBdirectories_only\fP, \fBcreate_symlinks\fP, \fBcreate_hard_links\fP }"
.br
.RI "Bitmask type\&. "
.ti -1c
.RI "enum class \fBdirectory_options\fP : unsigned char { \fBnone\fP, \fBfollow_directory_symlink\fP, \fBskip_permission_denied\fP }"
.br
.ti -1c
.RI "enum class \fBfile_type\fP : signed char { \fBnone\fP, \fBnot_found\fP, \fBregular\fP, \fBdirectory\fP, \fBsymlink\fP, \fBblock\fP, \fBcharacter\fP, \fBfifo\fP, \fBsocket\fP, \fBunknown\fP }"
.br
.ti -1c
.RI "enum class \fBperm_options\fP : unsigned { \fBreplace\fP, \fBadd\fP, \fBremove\fP, \fBnofollow\fP }"
.br
.RI "Bitmask type\&. "
.ti -1c
.RI "enum class \fBperms\fP : unsigned { \fBnone\fP, \fBowner_read\fP, \fBowner_write\fP, \fBowner_exec\fP, \fBowner_all\fP, \fBgroup_read\fP, \fBgroup_write\fP, \fBgroup_exec\fP, \fBgroup_all\fP, \fBothers_read\fP, \fBothers_write\fP, \fBothers_exec\fP, \fBothers_all\fP, \fBall\fP, \fBset_uid\fP, \fBset_gid\fP, \fBsticky_bit\fP, \fBmask\fP, \fBunknown\fP }"
.br
.RI "Bitmask type\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBpath\fP \fBabsolute\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "\fBpath\fP \fBabsolute\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "\fBpath\fP \fBcanonical\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "\fBpath\fP \fBcanonical\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "void \fBcopy\fP (const \fBpath\fP &__from, const \fBpath\fP &__to)"
.br
.ti -1c
.RI "void \fBcopy\fP (const \fBpath\fP &__from, const \fBpath\fP &__to, \fBcopy_options\fP __options)"
.br
.ti -1c
.RI "void \fBcopy\fP (const \fBpath\fP &__from, const \fBpath\fP &__to, \fBcopy_options\fP __options, \fBerror_code\fP &)"
.br
.ti -1c
.RI "void \fBcopy\fP (const \fBpath\fP &__from, const \fBpath\fP &__to, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "bool \fBcopy_file\fP (const \fBpath\fP &__from, const \fBpath\fP &__to)"
.br
.ti -1c
.RI "bool \fBcopy_file\fP (const \fBpath\fP &__from, const \fBpath\fP &__to, \fBcopy_options\fP __option)"
.br
.ti -1c
.RI "bool \fBcopy_file\fP (const \fBpath\fP &__from, const \fBpath\fP &__to, \fBcopy_options\fP __option, \fBerror_code\fP &)"
.br
.ti -1c
.RI "bool \fBcopy_file\fP (const \fBpath\fP &__from, const \fBpath\fP &__to, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "void \fBcopy_symlink\fP (const \fBpath\fP &__existing_symlink, const \fBpath\fP &__new_symlink)"
.br
.ti -1c
.RI "void \fBcopy_symlink\fP (const \fBpath\fP &__existing_symlink, const \fBpath\fP &__new_symlink, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBcreate_directories\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBcreate_directories\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "bool \fBcreate_directory\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBcreate_directory\fP (const \fBpath\fP &__p, const \fBpath\fP &attributes)"
.br
.ti -1c
.RI "bool \fBcreate_directory\fP (const \fBpath\fP &__p, const \fBpath\fP &attributes, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBcreate_directory\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "void \fBcreate_directory_symlink\fP (const \fBpath\fP &__to, const \fBpath\fP &__new_symlink)"
.br
.ti -1c
.RI "void \fBcreate_directory_symlink\fP (const \fBpath\fP &__to, const \fBpath\fP &__new_symlink, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "void \fBcreate_hard_link\fP (const \fBpath\fP &__to, const \fBpath\fP &__new_hard_link)"
.br
.ti -1c
.RI "void \fBcreate_hard_link\fP (const \fBpath\fP &__to, const \fBpath\fP &__new_hard_link, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "void \fBcreate_symlink\fP (const \fBpath\fP &__to, const \fBpath\fP &__new_symlink)"
.br
.ti -1c
.RI "void \fBcreate_symlink\fP (const \fBpath\fP &__to, const \fBpath\fP &__new_symlink, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "\fBpath\fP \fBcurrent_path\fP ()"
.br
.ti -1c
.RI "void \fBcurrent_path\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "void \fBcurrent_path\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "\fBpath\fP \fBcurrent_path\fP (\fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "bool \fBequivalent\fP (const \fBpath\fP &__p1, const \fBpath\fP &__p2)"
.br
.ti -1c
.RI "bool \fBequivalent\fP (const \fBpath\fP &__p1, const \fBpath\fP &__p2, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBexists\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBexists\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBexists\fP (\fBfile_status\fP) noexcept"
.br
.ti -1c
.RI "uintmax_t \fBfile_size\fP (const \fBpath\fP &)"
.br
.ti -1c
.RI "uintmax_t \fBfile_size\fP (const \fBpath\fP &, \fBerror_code\fP &) noexcept"
.br
.ti -1c
.RI "uintmax_t \fBhard_link_count\fP (const \fBpath\fP &)"
.br
.ti -1c
.RI "uintmax_t \fBhard_link_count\fP (const \fBpath\fP &, \fBerror_code\fP &) noexcept"
.br
.ti -1c
.RI "bool \fBis_block_file\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBis_block_file\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBis_block_file\fP (\fBfile_status\fP __s) noexcept"
.br
.ti -1c
.RI "bool \fBis_character_file\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBis_character_file\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBis_character_file\fP (\fBfile_status\fP __s) noexcept"
.br
.ti -1c
.RI "bool \fBis_directory\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBis_directory\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBis_directory\fP (\fBfile_status\fP __s) noexcept"
.br
.ti -1c
.RI "bool \fBis_empty\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBis_empty\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "bool \fBis_fifo\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBis_fifo\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBis_fifo\fP (\fBfile_status\fP __s) noexcept"
.br
.ti -1c
.RI "bool \fBis_other\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBis_other\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBis_other\fP (\fBfile_status\fP) noexcept"
.br
.ti -1c
.RI "bool \fBis_regular_file\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBis_regular_file\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBis_regular_file\fP (\fBfile_status\fP) noexcept"
.br
.ti -1c
.RI "bool \fBis_socket\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBis_socket\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBis_socket\fP (\fBfile_status\fP __s) noexcept"
.br
.ti -1c
.RI "bool \fBis_symlink\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBis_symlink\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "bool \fBis_symlink\fP (\fBfile_status\fP) noexcept"
.br
.ti -1c
.RI "\fBfile_time_type\fP \fBlast_write_time\fP (const \fBpath\fP &)"
.br
.ti -1c
.RI "\fBfile_time_type\fP \fBlast_write_time\fP (const \fBpath\fP &, \fBerror_code\fP &) noexcept"
.br
.ti -1c
.RI "void \fBlast_write_time\fP (const \fBpath\fP &__p, \fBfile_time_type\fP __new_time)"
.br
.ti -1c
.RI "void \fBlast_write_time\fP (const \fBpath\fP &__p, \fBfile_time_type\fP __new_time, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "constexpr \fBcopy_options\fP \fBoperator&\fP (\fBcopy_options\fP __x, \fBcopy_options\fP __y) noexcept"
.br
.ti -1c
.RI "constexpr directory_options \fBoperator&\fP (directory_options __x, directory_options __y) noexcept"
.br
.ti -1c
.RI "constexpr \fBperm_options\fP \fBoperator&\fP (\fBperm_options\fP __x, \fBperm_options\fP __y) noexcept"
.br
.ti -1c
.RI "constexpr \fBperms\fP \fBoperator&\fP (\fBperms\fP __x, \fBperms\fP __y) noexcept"
.br
.ti -1c
.RI "\fBcopy_options\fP & \fBoperator&=\fP (\fBcopy_options\fP &__x, \fBcopy_options\fP __y) noexcept"
.br
.ti -1c
.RI "directory_options & \fBoperator&=\fP (directory_options &__x, directory_options __y) noexcept"
.br
.ti -1c
.RI "\fBperm_options\fP & \fBoperator&=\fP (\fBperm_options\fP &__x, \fBperm_options\fP __y) noexcept"
.br
.ti -1c
.RI "\fBperms\fP & \fBoperator&=\fP (\fBperms\fP &__x, \fBperms\fP __y) noexcept"
.br
.ti -1c
.RI "constexpr \fBcopy_options\fP \fBoperator^\fP (\fBcopy_options\fP __x, \fBcopy_options\fP __y) noexcept"
.br
.ti -1c
.RI "constexpr directory_options \fBoperator^\fP (directory_options __x, directory_options __y) noexcept"
.br
.ti -1c
.RI "constexpr \fBperm_options\fP \fBoperator^\fP (\fBperm_options\fP __x, \fBperm_options\fP __y) noexcept"
.br
.ti -1c
.RI "constexpr \fBperms\fP \fBoperator^\fP (\fBperms\fP __x, \fBperms\fP __y) noexcept"
.br
.ti -1c
.RI "\fBcopy_options\fP & \fBoperator^=\fP (\fBcopy_options\fP &__x, \fBcopy_options\fP __y) noexcept"
.br
.ti -1c
.RI "directory_options & \fBoperator^=\fP (directory_options &__x, directory_options __y) noexcept"
.br
.ti -1c
.RI "\fBperm_options\fP & \fBoperator^=\fP (\fBperm_options\fP &__x, \fBperm_options\fP __y) noexcept"
.br
.ti -1c
.RI "\fBperms\fP & \fBoperator^=\fP (\fBperms\fP &__x, \fBperms\fP __y) noexcept"
.br
.ti -1c
.RI "constexpr \fBcopy_options\fP \fBoperator|\fP (\fBcopy_options\fP __x, \fBcopy_options\fP __y) noexcept"
.br
.ti -1c
.RI "constexpr directory_options \fBoperator|\fP (directory_options __x, directory_options __y) noexcept"
.br
.ti -1c
.RI "constexpr \fBperm_options\fP \fBoperator|\fP (\fBperm_options\fP __x, \fBperm_options\fP __y) noexcept"
.br
.ti -1c
.RI "constexpr \fBperms\fP \fBoperator|\fP (\fBperms\fP __x, \fBperms\fP __y) noexcept"
.br
.ti -1c
.RI "\fBcopy_options\fP & \fBoperator|=\fP (\fBcopy_options\fP &__x, \fBcopy_options\fP __y) noexcept"
.br
.ti -1c
.RI "directory_options & \fBoperator|=\fP (directory_options &__x, directory_options __y) noexcept"
.br
.ti -1c
.RI "\fBperm_options\fP & \fBoperator|=\fP (\fBperm_options\fP &__x, \fBperm_options\fP __y) noexcept"
.br
.ti -1c
.RI "\fBperms\fP & \fBoperator|=\fP (\fBperms\fP &__x, \fBperms\fP __y) noexcept"
.br
.ti -1c
.RI "constexpr \fBcopy_options\fP \fBoperator~\fP (\fBcopy_options\fP __x) noexcept"
.br
.ti -1c
.RI "constexpr directory_options \fBoperator~\fP (directory_options __x) noexcept"
.br
.ti -1c
.RI "constexpr \fBperm_options\fP \fBoperator~\fP (\fBperm_options\fP __x) noexcept"
.br
.ti -1c
.RI "constexpr \fBperms\fP \fBoperator~\fP (\fBperms\fP __x) noexcept"
.br
.ti -1c
.RI "void \fBpermissions\fP (const \fBpath\fP &, \fBperms\fP, \fBperm_options\fP, \fBerror_code\fP &) noexcept"
.br
.ti -1c
.RI "void \fBpermissions\fP (const \fBpath\fP &__p, \fBperms\fP __prms, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "void \fBpermissions\fP (const \fBpath\fP &__p, \fBperms\fP __prms, \fBperm_options\fP __opts=perm_options::replace)"
.br
.ti -1c
.RI "\fBpath\fP \fBproximate\fP (const \fBpath\fP &__p, const \fBpath\fP &__base, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "\fBpath\fP \fBproximate\fP (const \fBpath\fP &__p, const \fBpath\fP &__base=current_path())"
.br
.ti -1c
.RI "\fBpath\fP \fBproximate\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "\fBpath\fP \fBread_symlink\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "\fBpath\fP \fBread_symlink\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "\fBpath\fP \fBrelative\fP (const \fBpath\fP &__p, const \fBpath\fP &__base, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "\fBpath\fP \fBrelative\fP (const \fBpath\fP &__p, const \fBpath\fP &__base=current_path())"
.br
.ti -1c
.RI "\fBpath\fP \fBrelative\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "bool \fBremove\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "bool \fBremove\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "uintmax_t \fBremove_all\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "uintmax_t \fBremove_all\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "void \fBrename\fP (const \fBpath\fP &__from, const \fBpath\fP &__to)"
.br
.ti -1c
.RI "void \fBrename\fP (const \fBpath\fP &__from, const \fBpath\fP &__to, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "void \fBresize_file\fP (const \fBpath\fP &__p, uintmax_t __size)"
.br
.ti -1c
.RI "void \fBresize_file\fP (const \fBpath\fP &__p, uintmax_t __size, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "space_info \fBspace\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "space_info \fBspace\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec) noexcept"
.br
.ti -1c
.RI "\fBfile_status\fP \fBstatus\fP (const \fBpath\fP &)"
.br
.ti -1c
.RI "\fBfile_status\fP \fBstatus\fP (const \fBpath\fP &, \fBerror_code\fP &) noexcept"
.br
.ti -1c
.RI "bool \fBstatus_known\fP (\fBfile_status\fP) noexcept"
.br
.ti -1c
.RI "\fBfile_status\fP \fBsymlink_status\fP (const \fBpath\fP &)"
.br
.ti -1c
.RI "\fBfile_status\fP \fBsymlink_status\fP (const \fBpath\fP &, \fBerror_code\fP &) noexcept"
.br
.ti -1c
.RI "\fBpath\fP \fBtemp_directory_path\fP ()"
.br
.ti -1c
.RI "\fBpath\fP \fBtemp_directory_path\fP (\fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "\fBpath\fP \fBweakly_canonical\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "\fBpath\fP \fBweakly_canonical\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.in -1c
.SH "Detailed Description"
.PP 
ISO C++ 2017 namespace for File System library\&. 
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBstd::filesystem::copy_options\fP : unsigned short\fC [strong]\fP"

.PP
Bitmask type\&. 
.PP
Definition at line 81 of file bits/fs_fwd\&.h\&.
.SS "enum \fBstd::filesystem::perm_options\fP : unsigned\fC [strong]\fP"

.PP
Bitmask type\&. 
.PP
Definition at line 200 of file bits/fs_fwd\&.h\&.
.SS "enum \fBstd::filesystem::perms\fP : unsigned\fC [strong]\fP"

.PP
Bitmask type\&. 
.PP
Definition at line 134 of file bits/fs_fwd\&.h\&.
.SH "Author"
.PP 
Generated automatically by Doxygen for libstdc++ from the source code\&.