Struct WaitCause 

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

The word a plugin names one kind of wait by — see Clock::sleep_because.

One word: a nonempty run of printable ASCII with no whitespace, because a simulated clock carries it as one word of a line. WaitCause::new refuses anything else, and it is a const fn, so a cause declared as a constant that is not a word fails the build rather than reaching a clock.

Implementations

impl WaitCause

pub const fn new(word: &'static str) -> Self

The cause named word.

Panics

When word is not one word — at compile time, for a constant.

pub const fn is_word(text: &str) -> bool

Whether text is a word a cause may be: nonempty printable ASCII, no whitespace.

The one statement of the rule, for whatever reads a cause back off a clock’s wire.

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

The word itself.

Trait Implementations

impl Clone for WaitCause

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WaitCause

impl Debug for WaitCause

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

Formats the value using the given formatter.

impl Display for WaitCause

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

Formats the value using the given formatter.

impl Eq for WaitCause

impl Hash for WaitCause

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 PartialEq for WaitCause

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WaitCause