Struct step_dict::Word

pub struct Word<'a>(pub &'a str);

A word in the dictionary.

Examples

use step_dict::Word;

for word in Word("rust")..Word("rusty") {
    println!("{}", word);
}

Panics

This will panic if the word is not in the dictionary.

Tuple Fields

0: &'a str

Trait Implementations

impl<'a> Clone for Word<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Word<'a>

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

Formats the value using the given formatter.

impl Display for Word<'_>

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

Formats the value using the given formatter.

impl<'a> Ord for Word<'a>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a> PartialEq<Word<'a>> for Word<'a>

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

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

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

This method tests for !=.

impl<'a> PartialOrd<Word<'a>> for Word<'a>

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Step for Word<'_>

fn steps_between(Self: &Self, Self: &Self) -> Option<usize>

🔬 This is a nightly-only experimental API. (step_trait)

Returns the number of successor steps required to get from start to end.

fn forward_checked(Self: Self, count: usize) -> Option<Self>

🔬 This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the successor of self count times.

fn backward_checked(Self: Self, count: usize) -> Option<Self>

🔬 This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the predecessor of self count times.

fn forward(start: Self, count: usize) -> Self

🔬 This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the successor of self count times.

unsafe fn forward_unchecked(start: Self, count: usize) -> Self

🔬 This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the successor of self count times.

fn backward(start: Self, count: usize) -> Self

🔬 This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the predecessor of self count times.

unsafe fn backward_unchecked(start: Self, count: usize) -> Self

🔬 This is a nightly-only experimental API. (step_trait)

Returns the value that would be obtained by taking the predecessor of self count times.

impl<'a> Copy for Word<'a>

impl<'a> Eq for Word<'a>

impl<'a> StructuralEq for Word<'a>

impl<'a> StructuralPartialEq for Word<'a>