Struct snake_case::SnakeCaseRef

pub struct SnakeCaseRef<'a>(_);

An non-owning string type that can only refer to string containing valid snake_case. In other words, it always matches ^[_a-z][_a-z0-9]*$

• Non-empty
• Starts with a lower case ASCII letter or underscore
• Contains only lower case ASCII letters, underscores and digits

Implementations

impl<'a> SnakeCaseRef<'a>

pub const fn try_from_str(s: &str) -> Result<SnakeCaseRef<'_>, InvalidSnakeCase>

pub const fn as_str(&self) -> &'a str

pub fn to_owned(&self) -> SnakeCase

Trait Implementations

impl Borrow<str> for SnakeCaseRef<'_>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<'a> Clone for SnakeCaseRef<'a>

fn clone(&self) -> SnakeCaseRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for SnakeCaseRef<'a>

impl Debug for SnakeCaseRef<'_>

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

Formats the value using the given formatter.

impl Display for SnakeCaseRef<'_>

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

Formats the value using the given formatter.

impl<'a> Eq for SnakeCaseRef<'a>

impl<'a> Hash for SnakeCaseRef<'a>

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for SnakeCaseRef<'a>

fn cmp(&self, other: &SnakeCaseRef<'a>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<&'_ str> for SnakeCaseRef<'_>

fn eq(&self, other: &&str) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<SnakeCaseRef<'a>> for SnakeCaseRef<'a>

fn eq(&self, other: &SnakeCaseRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SnakeCaseRef<'a>) -> bool

This method tests for !=.

impl PartialEq<String> for SnakeCaseRef<'_>

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<str> for SnakeCaseRef<'_>

fn eq(&self, other: &str) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialOrd<SnakeCaseRef<'a>> for SnakeCaseRef<'a>

fn partial_cmp(&self, other: &SnakeCaseRef<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> StructuralEq for SnakeCaseRef<'a>

impl<'a> StructuralPartialEq for SnakeCaseRef<'a>

impl<'a> TryFrom<&'a str> for SnakeCaseRef<'a>

type Error = InvalidSnakeCase

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.