Struct UniqueId

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

The unique ID of a Change, used to set the file name of the Markdown file.

Implementations

impl UniqueId

pub fn to_file_name(&self) -> String

pub fn exact<T: AsRef<str>>(value: T) -> Self

Creates a new UniqueId from a string without altering the value at all. For working on with existing paths. Use Self::normalize when creating new files.

pub fn normalize<T: AsRef<str>>(value: T) -> Self

Converts an arbitrary string into only lower case letters and underscores, for creating file names from arbitrary strings.

Trait Implementations

impl Clone for UniqueId

fn clone(&self) -> UniqueId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UniqueId

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

Formats the value using the given formatter.

impl Display for UniqueId

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

Formats the value using the given formatter.

impl Ord for UniqueId

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

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

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

impl StructuralPartialEq for UniqueId