standard_lib/fs/dir/
mod.rs

1//! Types for interacting with the directories of a file system. Simpler than the file module, this
2//! one is primarily focussed on the [`Directory`] and [`DirEntry`] types.
3//! 
4//! This module provides the [`Directory`] type and associated types, including errors and
5//! iterators.
6//! 
7//! # Opening
8//! With less options relevant while opening `Directory`s, this module current does not provide a
9//! builder like file's [`OpenOptions`](crate::fs::file::OpenOptions). This may change in the
10//! future, if more relevant options are found.
11//! 
12//! # Access Mode
13//! Unlike [`File`](crate::fs::File)s, `Directory`s are currently not associated with an access mode
14//! to restrict operations at compile time. This may be changed in the future however, if it helps
15//! to better represent the underlying entity and its functionality.
16// TODO: Write more docs.
17
18mod dir;
19mod dir_entry;
20
21pub use dir::*;
22pub use dir_entry::*;