Struct M2dir 

pub struct M2dir { /* private fields */ }

A single m2dir directory on the filesystem.

Holds the root path and provides helpers to derive entry paths, metadata paths, and a new filename for a delivery.

Implementations

impl M2dir

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

Builds an M2dir from a path without checking the marker.

pub fn path(&self) -> &M2dirPath

Returns the path to the m2dir directory.

pub fn marker_path(&self) -> M2dirPath

Returns the path to the .m2dir marker file.

pub fn meta_dir(&self) -> M2dirPath

Returns the path to the .meta directory.

pub fn flags_path(&self, id: &str) -> M2dirPath

Returns the path to the .flags metadata file for the given entry id.

pub fn entry_path( &self, bytes: &[u8], nonce_bytes: &[u8], ) -> (String, M2dirPath)

Computes the filename and final on-disk path for a new entry holding bytes. The filename is <date>,<checksum>.<nonce> per the m2dir specification.

nonce_bytes should be 4 freshly-generated random bytes supplied by the caller.

pub fn tmp_path(&self, pid: u32, counter: u32) -> M2dirPath

Returns the path of a temporary file inside this m2dir, used during the write-then-rename delivery sequence.

pub fn parse_filename_id(filename: &str) -> Option<&str>

Splits a filename into its <checksum>.<nonce> tail (used as the entry id).

Trait Implementations

impl AsRef<M2dirPath> for M2dir

fn as_ref(&self) -> &M2dirPath

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

impl AsRef<str> for M2dir

fn as_ref(&self) -> &str

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

impl Clone for M2dir

fn clone(&self) -> M2dir

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for M2dir

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

Formats the value using the given formatter.

impl Eq for M2dir

impl From<&str> for M2dir

fn from(path: &str) -> Self

Converts to this type from the input type.

impl From<M2dirPath> for M2dir

fn from(path: M2dirPath) -> Self

Converts to this type from the input type.

impl From<String> for M2dir

fn from(path: String) -> Self

Converts to this type from the input type.

impl Hash for M2dir

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 Ord for M2dir

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

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

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