Struct Name 

pub struct Name(String);

What a container is called, wherever it is kept.

One segment, never a path: a rename gives the document another name and never another home, which is what a rename box is for. The container extension is part of it, because the container’s own name is the document’s.

Tuple Fields

0: String

Implementations

impl Name

pub fn new(name: &str) -> Option<Self>

The name as it is spelled, or None for one that is no name: blank, hidden, or more than one segment.

pub fn of_document(name: &str) -> Option<Self>

What the user typed, as a container is named: the suffix is appended rather than substituted, since a document called notes.v2 should not become notes.bwx.

pub fn of_archive(file: &str) -> Option<Self>

The container an archive’s file name says it carries: engine.bwx.zip carries engine.bwx.

pub fn as_str(&self) -> &str

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Display for Name

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

Formats the value using the given formatter.

impl Ord for Name

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

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

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

impl StructuralPartialEq for Name