Struct RelativePath 

pub struct RelativePath(/* private fields */);

A path below a folder, as the names the app gives, outermost first: an album’s name, then a track’s. Each name is one name on every platform, whatever it holds, / and \ included. Coven writes each through one rule that makes it valid on any volume (§17.3), so joined to the folder the path stays inside it.

Implementations

impl RelativePath

pub fn new<S: Into<String>>( names: impl IntoIterator<Item = S>, ) -> Result<Self, RelativePathError>

The path of names, outermost first. Each must be non-empty.

pub fn names(&self) -> impl Iterator<Item = &str>

Its names as the app gave them, outermost first.

pub fn local_path(&self) -> PathBuf

The path coven writes for it below a folder: each name as the one rule for every platform makes it (§17.3), joined by this platform’s separator. An app writing a file of its own under a name it stores writes it here, so its names land as coven’s copies do.

Trait Implementations

impl Clone for RelativePath

fn clone(&self) -> RelativePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelativePath

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

Formats the value using the given formatter.

impl Display for RelativePath

The names joined by /, for showing only: a name may hold / itself.

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

Formats the value using the given formatter.

impl Ord for RelativePath

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

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

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

impl StructuralPartialEq for RelativePath