Struct Description 

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

Implementations

impl Description

pub const MIN_CHAR_LENGTH: usize = 3usize

pub const MAX_CHAR_LENGTH: usize = 10_000usize

pub fn new<T: AsRef<str> + Into<String>>( description: T, ) -> Result<Self, DescriptionError>

Creates a new Description from any type that implements AsRef<str> and Into<CompactString>.

Errors

Returns an Err if the description is less than 3 characters long or more than 10,000 characters long.

pub unsafe fn new_unchecked<T: Into<String>>(description: T) -> Self

Creates a new Description from any type that implements Into<String> without checking its validity.

Safety

The description must not be less than 3 characters long or more than 10,000 characters long.

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

Extracts a string slice containing the entire Description.

Trait Implementations

impl AsRef<str> for Description

fn as_ref(&self) -> &str

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

impl Clone for Description

fn clone(&self) -> Description

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Description

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

Formats the value using the given formatter.

impl Display for Description

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

Formats the value using the given formatter.

impl FromStr for Description

type Err = DescriptionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Description

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 Description

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

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

fn partial_cmp(&self, other: &Description) -> 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 TryFrom<String> for Description

type Error = DescriptionError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Description

impl StructuralPartialEq for Description