Struct CaselessFs

pub struct CaselessFs<S> { /* private fields */ }

Caseless filesystem wrapping an inner filesystem.

Implementations

impl<S: Store> CaselessFs<S>

pub fn new(inner: S) -> Self

Creates a new caseless filesystem with the provided inner filesystem. It treats paths as case-insensitive, regardless of the case of the inner filesystem.

pub fn into_inner(self) -> S

Moves the inner filesystem out of the caseless filesystem. Inspired by std::io::Cursor.

pub fn get_ref(&self) -> &S

Gets a reference to the inner filesystem. Inspired by std::io::Cursor.

pub fn get_mut(&mut self) -> &mut S

Gets a mutable reference to the inner filesystem. Inspired by std::io::Cursor.

pub fn find<P: AsRef<Path>>(&self, path: P) -> Vec<PathBuf>

Finds paths that match the caseless path. Path components with valid utf8 are compared in a case-insensitive way. Path components with invalid utf8 are compared raw (case-sensitive).

Trait Implementations

impl<S: Clone> Clone for CaselessFs<S>

fn clone(&self) -> CaselessFs<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for CaselessFs<S>

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

Formats the value using the given formatter.

impl<S: Store> Store for CaselessFs<S>

fn open_path(&self, path: &Path) -> Result<Self::File>

Opens the file identified by the caseless path. A caseless path that matches the real path of a file always opens that file. Otherwise a caseless path will open the first path of the inner filesystem that matches the caseless path.

fn entries_path(&self, path: &Path) -> Result<Entries<'_>>

Iterates over the entries of the inner filesystem.

type File = <S as Store>::File