Struct Slug

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

An owned slug, checked for syntax

The syntax check can be relied on for safety/soundness.

Implementations

impl Slug

pub fn new(s: String) -> Result<Slug, BadSlug>

Make a Slug out of an owned String, if it has the correct syntax

pub unsafe fn new_unchecked(s: String) -> Slug

Make a Slug out of an owned String, without checking the syntax

Safety

It’s the caller’s responsibility to check the syntax of the input string.

Methods from Deref<Target = SlugRef>

pub fn as_str(&self) -> &str

Obtain this slug as a str

pub fn as_path(&self) -> &Path

Obtain this slug as a Path

Trait Implementations

impl AsRef<[u8]> for Slug

fn as_ref(&self) -> &[u8]

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

impl AsRef<OsStr> for Slug

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for Slug

fn as_ref(&self) -> &Path

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

impl AsRef<str> for Slug

fn as_ref(&self) -> &str

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

impl Borrow<SlugRef> for Slug

fn borrow(&self) -> &SlugRef

Immutably borrows from an owned value.

impl Borrow<str> for Slug

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Slug

fn clone(&self) -> Slug

Returns a copy 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

Formats the value using the given formatter.

impl Deref for Slug

type Target = SlugRef

The resulting type after dereferencing.

fn deref(&self) -> &SlugRef

Dereferences the value.

impl<'de> Deserialize<'de> for Slug

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Slug

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

Formats the value using the given formatter.

impl From<HsNickname> for Slug

fn from(value: HsNickname) -> Self

Converts to this type from the input type.

impl From<Slug> for HsNickname

fn from(value: Slug) -> Self

Converts to this type from the input type.

impl From<Slug> for String

fn from(s: Slug) -> String

Converts to this type from the input type.

impl Hash for Slug

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 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 Serialize for Slug

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for Slug

type Error = BadSlug

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Slug, BadSlug>

Performs the conversion.

impl TryInto<Slug> for Iso8601TimeSlug

type Error = Bug

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Slug, Self::Error>

Performs the conversion.

impl Eq for Slug

impl StructuralPartialEq for Slug