Struct include_dir::Dir

pub struct Dir<'a> { /* private fields */ }

A directory.

Implementations

impl<'a> Dir<'a>

pub const fn new(path: &'a str, entries: &'a [DirEntry<'a>]) -> Self

Create a new Dir.

pub fn path(&self) -> &'a Path

The full path for this Dir, relative to the directory passed to crate::include_dir!().

pub const fn entries(&self) -> &'a [DirEntry<'a>]

The entries within this Dir.

pub fn files(&self) -> impl Iterator<Item = &'a File<'a>> + 'a

Get a list of the files in this directory.

pub fn dirs(&self) -> impl Iterator<Item = &'a Dir<'a>> + 'a

Get a list of the sub-directories inside this directory.

pub fn get_entry<S: AsRef<Path>>(&self, path: S) -> Option<&'a DirEntry<'a>>

Recursively search for a DirEntry with a particular path.

pub fn get_file<S: AsRef<Path>>(&self, path: S) -> Option<&'a File<'a>>

Look up a file by name.

pub fn get_dir<S: AsRef<Path>>(&self, path: S) -> Option<&'a Dir<'a>>

Look up a dir by name.

pub fn contains<S: AsRef<Path>>(&self, path: S) -> bool

Does this directory contain path?

pub fn extract<S: AsRef<Path>>(&self, base_path: S) -> Result<()>

Create directories and extract all files to real filesystem. Creates parent directories of path if they do not already exist. Fails if some files already exist. In case of error, partially extracted directory may remain on the filesystem.

impl<'a> Dir<'a>

pub fn find(
    &self,
    glob: &str
) -> Result<impl Iterator<Item = &'a DirEntry<'a>>, PatternError>

Search for a file or directory with a glob pattern.

Trait Implementations

impl<'a> Clone for Dir<'a>

fn clone(&self) -> Dir<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Dir<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Dir<'a>> for Dir<'a>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> StructuralPartialEq for Dir<'a>