---
name: "std::filesystem_directory_iterator"
section: "3cxx"
platform: "linux"
package: "libstdc++-11-doc"
version: "11.3.0-12"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/std::filesystem_directory_iterator"
---

# std::filesystem\_directory\_iterator(3cxx)

Iterator type for traversing the entries in a single directory.

## NAME

std::filesystem::directory\_iterator - Iterator type for traversing the entries in a single directory.

## SYNOPSIS

`#include <fs_dir.h>`

### Public Types

typedef ptrdiff\_t **difference\_type**\
 typedef **input\_iterator\_tag** **iterator\_category**\
 typedef const **directory\_entry** \* **pointer**\
 typedef const **directory\_entry** & **reference**\
 typedef **directory\_entry** **value\_type**\

### Public Member Functions

**directory\_iterator** (const **directory\_iterator** &\_\_rhs)=default\
 **directory\_iterator** (const **path** &\_\_p)\
 **directory\_iterator** (const **path** &\_\_p, **directory\_options** \_\_options)\
 **directory\_iterator** (const **path** &\_\_p, **directory\_options** \_\_options, **error\_code** &\_\_ec)\
 **directory\_iterator** (const **path** &\_\_p, **error\_code** &\_\_ec)\
 **directory\_iterator** (**directory\_iterator** &&\_\_rhs) noexcept=default\
 **directory\_iterator** & **increment** (**error\_code** &\_\_ec)\
 const **directory\_entry** & **operator\*** () const noexcept\
 **directory\_iterator** & **operator++** ()\
 **\_\_directory\_iterator\_proxy** **operator++** (int)\
 const **directory\_entry** \* **operator-\>** () const noexcept\
 **directory\_iterator** & **operator=** (const **directory\_iterator** &\_\_rhs)=default\
 **directory\_iterator** & **operator=** (**directory\_iterator** &&\_\_rhs) noexcept=default\

### Friends

bool **operator!=** (const **directory\_iterator** &\_\_lhs, const **directory\_iterator** &\_\_rhs) noexcept\
 bool **operator==** (const **directory\_iterator** &\_\_lhs, const **directory\_iterator** &\_\_rhs) noexcept\
 class **recursive\_directory\_iterator**\

### Related Functions

(Note that these are not member functions.)

**directory\_iterator** **begin** (**directory\_iterator** \_\_iter) noexcept\
 Enable range-based `for` using directory\_iterator.  **directory\_iterator** **end** (**directory\_iterator**) noexcept\
 Return a past-the-end directory\_iterator.

## Detailed Description

Iterator type for traversing the entries in a single directory.

Definition at line **374** of file **bits/fs\_dir.h**.

## Member Typedef Documentation

### typedef ptrdiff\_t std::filesystem::directory\_iterator::difference\_type

Definition at line **378** of file **bits/fs\_dir.h**.

### typedef input\_iterator\_tag std::filesystem::directory\_iterator::iterator\_category

Definition at line **381** of file **bits/fs\_dir.h**.

### typedef const directory\_entry\* std::filesystem::directory\_iterator::pointer

Definition at line **379** of file **bits/fs\_dir.h**.

### typedef const directory\_entry& std::filesystem::directory\_iterator::reference

Definition at line **380** of file **bits/fs\_dir.h**.

### typedef directory\_entry std::filesystem::directory\_iterator::value\_type

Definition at line **377** of file **bits/fs\_dir.h**.

## Constructor & Destructor Documentation

### std::filesystem::directory\_iterator::directory\_iterator (const path & \_\_p)` [inline]`, ` [explicit]`

Definition at line **386** of file **bits/fs\_dir.h**.

### std::filesystem::directory\_iterator::directory\_iterator (const path & \_\_p, directory\_options \_\_options)` [inline]`

Definition at line **389** of file **bits/fs\_dir.h**.

### std::filesystem::directory\_iterator::directory\_iterator (const path & \_\_p, error\_code & \_\_ec)` [inline]`

Definition at line **392** of file **bits/fs\_dir.h**.

### std::filesystem::directory\_iterator::directory\_iterator (const path & \_\_p, directory\_options \_\_options, error\_code & \_\_ec)` [inline]`

Definition at line **395** of file **bits/fs\_dir.h**.

## Member Function Documentation

### \_\_directory\_iterator\_proxy std::filesystem::directory\_iterator::operator++ (int)` [inline]`

Definition at line **416** of file **bits/fs\_dir.h**.

### const directory\_entry \* std::filesystem::directory\_iterator::operator-\> () const` [inline]`, ` [noexcept]`

Definition at line **412** of file **bits/fs\_dir.h**.

## Friends And Related Function Documentation

### bool operator!= (const directory\_iterator & \_\_lhs, const directory\_iterator & \_\_rhs)` [friend]`

Definition at line **435** of file **bits/fs\_dir.h**.

### bool operator== (const directory\_iterator & \_\_lhs, const directory\_iterator & \_\_rhs)` [friend]`

Definition at line **427** of file **bits/fs\_dir.h**.

### friend class recursive\_directory\_iterator` [friend]`

Definition at line **439** of file **bits/fs\_dir.h**.

## Author

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