Struct StorybookStoryName 

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

Validated Storybook story name metadata.

Implementations

impl StorybookStoryName

pub fn new(input: &str) -> Result<StorybookStoryName, StorybookNameError>

Creates Storybook story name metadata.

Errors

Returns StorybookNameError when input is empty or contains control characters.

pub fn as_str(&self) -> &str

Returns the story name.

Trait Implementations

impl Clone for StorybookStoryName

fn clone(&self) -> StorybookStoryName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorybookStoryName

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

Formats the value using the given formatter.

impl Display for StorybookStoryName

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

Formats the value using the given formatter.

impl FromStr for StorybookStoryName

type Err = StorybookNameError

The associated error which can be returned from parsing.

fn from_str( input: &str, ) -> Result<StorybookStoryName, <StorybookStoryName as FromStr>::Err>

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

impl Hash for StorybookStoryName

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 StorybookStoryName

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

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

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

type Error = StorybookNameError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<StorybookStoryName, <StorybookStoryName as TryFrom<&str>>::Error>

Performs the conversion.

impl Eq for StorybookStoryName

impl StructuralPartialEq for StorybookStoryName