Struct M2dirStore 

pub struct M2dirStore { /* private fields */ }

Root m2store directory holding one or more crate::m2dir::types::M2dirs.

Implementations

impl M2dirStore

pub fn from_path(path: impl Into<M2dirPath>) -> Self

Builds an M2dirStore from a path without checking the marker.

pub fn path(&self) -> &M2dirPath

Returns the path to the m2store root directory.

pub fn marker_path(&self) -> M2dirPath

Returns the path to the .m2store marker file.

pub fn delivery_path(&self) -> M2dirPath

Returns the path to the .delivery entry.

pub fn resolve_folder_path( &self, name: &str, ) -> Result<M2dirPath, M2dirStoreError>

Resolves a folder name (relative path, components percent encoded per the m2dir specification) to its on-disk path inside this store.

Returns an error if name is absolute or escapes the store root.

pub fn decode_folder_name(&self, path: &M2dirPath) -> Option<String>

Decodes a path inside the store back to its UTF-8 folder name.

Trait Implementations

impl AsRef<M2dirPath> for M2dirStore

fn as_ref(&self) -> &M2dirPath

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

impl AsRef<str> for M2dirStore

fn as_ref(&self) -> &str

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

impl Clone for M2dirStore

fn clone(&self) -> M2dirStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for M2dirStore

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

Formats the value using the given formatter.

impl Eq for M2dirStore

impl From<M2dirPath> for M2dirStore

fn from(path: M2dirPath) -> Self

Converts to this type from the input type.

impl Ord for M2dirStore

fn cmp(&self, other: &M2dirStore) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for M2dirStore

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

fn partial_cmp(&self, other: &M2dirStore) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for M2dirStore