Struct SlugRef

#[repr(transparent)]
pub struct SlugRef(str);

A borrwed slug, checked for syntax

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

Tuple Fields

0: str

Implementations

impl SlugRef

pub fn new(s: &str) -> Result<&SlugRef, BadSlug>

Make a SlugRef out of a str, if it has the correct syntax

pub unsafe fn new_unchecked<'s>(s: &'s str) -> &'s SlugRef

Make a SlugRef out of a str, without checking the syntax

Safety

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

fn to_slug(&self) -> Slug

Make an owned Slug

impl SlugRef

pub fn as_str(&self) -> &str

Obtain this slug as a str

impl SlugRef

pub fn as_path(&self) -> &Path

Obtain this slug as a Path

Trait Implementations

impl<'i> AsRef<&'i SlugRef> for InstancePurgeInfo<'i>

Available on crate feature state-dir only.

fn as_ref(&self) -> &&'i SlugRef

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

impl AsRef<[u8]> for SlugRef

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

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

impl AsRef<OsStr> for SlugRef

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for SlugRef

fn as_ref(&self) -> &Path

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

impl AsRef<str> for SlugRef

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 Debug for SlugRef

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

Formats the value using the given formatter.

impl Display for SlugRef

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

Formats the value using the given formatter.

impl Hash for SlugRef

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

Feeds this value into the given Hasher.

impl Ord for SlugRef

fn cmp(&self, other: &SlugRef) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq for SlugRef

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToOwned for SlugRef

type Owned = Slug

The resulting type after obtaining ownership.

fn to_owned(&self) -> Slug

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<'s> TryFrom<&'s str> for &'s SlugRef

type Error = BadSlug

The type returned in the event of a conversion error.

fn try_from(s: &'s str) -> Result<&'s SlugRef, BadSlug>

Performs the conversion.

impl Eq for SlugRef

impl StructuralPartialEq for SlugRef