Struct Slug 

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

Implementations

impl Slug

pub fn new(input: &str) -> Result<Slug, SlugError>

Creates a normalized slug from user-provided text.

Errors

Returns SlugError::Empty when normalization produces an empty value or another SlugError variant when the canonical representation is invalid.

Examples found in repository

examples/facade_identifier_slug.rs (line 5)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let identifier = Identifier::new("acct_42")?;
    let slug = Slug::new("RustUse Docs")?;

    assert_eq!(identifier.as_str(), "acct_42");
    assert_eq!(slug.as_str(), "rustuse-docs");

    Ok(())
}

pub fn as_str(&self) -> &str

Examples found in repository

examples/facade_identifier_slug.rs (line 8)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let identifier = Identifier::new("acct_42")?;
    let slug = Slug::new("RustUse Docs")?;

    assert_eq!(identifier.as_str(), "acct_42");
    assert_eq!(slug.as_str(), "rustuse-docs");

    Ok(())
}

pub fn into_inner(self) -> String

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

Trait Implementations

impl Clone for Slug

fn clone(&self) -> Slug

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Slug

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

Formats the value using the given formatter.

impl Display for Slug

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

Formats the value using the given formatter.

impl Hash for Slug

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Slug

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

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

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

impl StructuralPartialEq for Slug