.TH "std::filesystem::directory_iterator" 3cxx "Thu Feb 16 2023" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::filesystem::directory_iterator \- Iterator type for traversing the entries in a single directory\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <fs_dir\&.h>\fP
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef ptrdiff_t \fBdifference_type\fP"
.br
.ti -1c
.RI "typedef \fBinput_iterator_tag\fP \fBiterator_category\fP"
.br
.ti -1c
.RI "typedef const \fBdirectory_entry\fP * \fBpointer\fP"
.br
.ti -1c
.RI "typedef const \fBdirectory_entry\fP & \fBreference\fP"
.br
.ti -1c
.RI "typedef \fBdirectory_entry\fP \fBvalue_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBdirectory_iterator\fP (const \fBdirectory_iterator\fP &__rhs)=default"
.br
.ti -1c
.RI "\fBdirectory_iterator\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "\fBdirectory_iterator\fP (const \fBpath\fP &__p, \fBdirectory_options\fP __options)"
.br
.ti -1c
.RI "\fBdirectory_iterator\fP (const \fBpath\fP &__p, \fBdirectory_options\fP __options, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "\fBdirectory_iterator\fP (const \fBpath\fP &__p, \fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "\fBdirectory_iterator\fP (\fBdirectory_iterator\fP &&__rhs) noexcept=default"
.br
.ti -1c
.RI "\fBdirectory_iterator\fP & \fBincrement\fP (\fBerror_code\fP &__ec)"
.br
.ti -1c
.RI "const \fBdirectory_entry\fP & \fBoperator*\fP () const noexcept"
.br
.ti -1c
.RI "\fBdirectory_iterator\fP & \fBoperator++\fP ()"
.br
.ti -1c
.RI "\fB__directory_iterator_proxy\fP \fBoperator++\fP (int)"
.br
.ti -1c
.RI "const \fBdirectory_entry\fP * \fBoperator\->\fP () const noexcept"
.br
.ti -1c
.RI "\fBdirectory_iterator\fP & \fBoperator=\fP (const \fBdirectory_iterator\fP &__rhs)=default"
.br
.ti -1c
.RI "\fBdirectory_iterator\fP & \fBoperator=\fP (\fBdirectory_iterator\fP &&__rhs) noexcept=default"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBdirectory_iterator\fP &__lhs, const \fBdirectory_iterator\fP &__rhs) noexcept"
.br
.ti -1c
.RI "bool \fBoperator==\fP (const \fBdirectory_iterator\fP &__lhs, const \fBdirectory_iterator\fP &__rhs) noexcept"
.br
.ti -1c
.RI "class \fBrecursive_directory_iterator\fP"
.br
.in -1c
.SS "Related Functions"
(Note that these are not member functions\&.) 
.PP
.RI "\fB\fP"
.br

.in +1c
.in +1c
.ti -1c
.RI "\fBdirectory_iterator\fP \fBbegin\fP (\fBdirectory_iterator\fP __iter) noexcept"
.br
.RI "Enable range-based \fCfor\fP using directory_iterator\&. "
.ti -1c
.RI "\fBdirectory_iterator\fP \fBend\fP (\fBdirectory_iterator\fP) noexcept"
.br
.RI "Return a past-the-end directory_iterator\&. "
.in -1c
.in -1c
.SH "Detailed Description"
.PP 
Iterator type for traversing the entries in a single directory\&. 
.PP
Definition at line \fB374\fP of file \fBbits/fs_dir\&.h\fP\&.
.SH "Member Typedef Documentation"
.PP 
.SS "typedef ptrdiff_t std::filesystem::directory_iterator::difference_type"

.PP
Definition at line \fB378\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "typedef \fBinput_iterator_tag\fP \fBstd::filesystem::directory_iterator::iterator_category\fP"

.PP
Definition at line \fB381\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "typedef const \fBdirectory_entry\fP* \fBstd::filesystem::directory_iterator::pointer\fP"

.PP
Definition at line \fB379\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "typedef const \fBdirectory_entry\fP& \fBstd::filesystem::directory_iterator::reference\fP"

.PP
Definition at line \fB380\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "typedef \fBdirectory_entry\fP \fBstd::filesystem::directory_iterator::value_type\fP"

.PP
Definition at line \fB377\fP of file \fBbits/fs_dir\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "std::filesystem::directory_iterator::directory_iterator (const \fBpath\fP & __p)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Definition at line \fB386\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "std::filesystem::directory_iterator::directory_iterator (const \fBpath\fP & __p, \fBdirectory_options\fP __options)\fC [inline]\fP"

.PP
Definition at line \fB389\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "std::filesystem::directory_iterator::directory_iterator (const \fBpath\fP & __p, \fBerror_code\fP & __ec)\fC [inline]\fP"

.PP
Definition at line \fB392\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "std::filesystem::directory_iterator::directory_iterator (const \fBpath\fP & __p, \fBdirectory_options\fP __options, \fBerror_code\fP & __ec)\fC [inline]\fP"

.PP
Definition at line \fB395\fP of file \fBbits/fs_dir\&.h\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "\fB__directory_iterator_proxy\fP std::filesystem::directory_iterator::operator++ (int)\fC [inline]\fP"

.PP
Definition at line \fB416\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "const \fBdirectory_entry\fP * std::filesystem::directory_iterator::operator\-> () const\fC [inline]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB412\fP of file \fBbits/fs_dir\&.h\fP\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "bool operator!= (const \fBdirectory_iterator\fP & __lhs, const \fBdirectory_iterator\fP & __rhs)\fC [friend]\fP"

.PP
Definition at line \fB435\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "bool operator== (const \fBdirectory_iterator\fP & __lhs, const \fBdirectory_iterator\fP & __rhs)\fC [friend]\fP"

.PP
Definition at line \fB427\fP of file \fBbits/fs_dir\&.h\fP\&.
.SS "friend class \fBrecursive_directory_iterator\fP\fC [friend]\fP"

.PP
Definition at line \fB439\fP of file \fBbits/fs_dir\&.h\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for libstdc++ from the source code\&.