Struct Dir

pub struct Dir { /* private fields */ }

Represents a directory, which may be embedded or from the filesystem. Provides methods to enumerate and access files and subdirectories. Represents a directory, which may be embedded or from the filesystem. Provides methods to enumerate and access files and subdirectories.

Implementations

impl Dir

pub const fn from_embedded(dir: Dir<'static>, path: &'static str) -> Self

Creates a directory from an embedded include_dir::Dir and its root path. Intended for use in tests and advanced scenarios.

pub fn from_path(path: &Path) -> Self

Creates a new directory from the given path, relative to the manifest directory at build time. The path can be any valid subdirectory or file path.

pub fn into_dynamic(self) -> Self

Converts an embedded directory to a dynamic (filesystem-backed) directory if possible. For embedded directories, this will create a Path variant using the embedded root path.

pub fn auto_dynamic(self) -> Self

Automatically converts to a dynamic directory if in debug mode (cfg!(debug_assertions)). In release mode, returns self unchanged.

pub fn from_str(path: &'static str) -> Self

Creates a new root directory from the given string path, relative to the manifest directory. The path must be a string literal or static string.

pub fn is_embedded(&self) -> bool

Returns true if this directory is embedded in the binary.

pub fn path(&self) -> &Path

Returns the relative path of this directory.

pub fn absolute_path(&self) -> &Path

Returns the absolute path of this directory.

pub fn entries(&self) -> Vec<DirEntry>

Returns all immediate entries (files and subdirectories) in this directory.

pub fn get_file(&self, name: &str) -> Option<File>

Returns the file with the given name if it exists in this directory. The name is relative to the directory root.

pub fn get_dir(&self, name: &str) -> Option<Dir>

Returns a reference to the directory with the given name, if it exists.

pub fn walk(&self) -> impl Iterator<Item = File>

Recursively walks all files in this directory and its subdirectories. Returns an iterator over all files found.

Trait Implementations

impl Clone for Dir

fn clone(&self) -> Dir

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Dir

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Dir

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Dir

fn eq(&self, other: &Dir) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Dir

impl StructuralPartialEq for Dir