Struct Folder 

pub struct Folder { /* private fields */ }

A folder is an M2dir embedded in the context of an M2store.

Implementations

impl Folder

pub fn abs_path(&self) -> &PathBuf

pub fn path(&self) -> &PathBuf

pub fn name(&self) -> String

pub fn virtual_name(&self, delimiter: &str) -> String

pub fn subfolders(&self) -> Folders

Returns an iterator over subdirectories.

pub fn subfolder(&self, name: &str) -> Result<Option<Folder>, Error>

pub fn add_subfolder(&self, folder: impl AsRef<Path>) -> Result<Folder, Error>

Creates all neccessary directories if they don’t exist yet. It is the library user’s responsibility to call this when e.g. creating a new folder.

Trait Implementations

impl AsRef<M2dir> for Folder

fn as_ref(&self) -> &M2dir

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Folder

fn clone(&self) -> Folder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Folder

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

Formats the value using the given formatter.

impl PartialEq for Folder

fn eq(&self, other: &Folder) -> 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 Folder

impl StructuralPartialEq for Folder