Enum bellframe::Stroke

#[repr(u8)]
pub enum Stroke {
    Hand,
    Back,
}

Stroke of a row, i.e. handstroke (Stroke::Hand) or backstroke (Stroke::Back).

Variants

Hand

Back

Implementations

impl Stroke

pub fn offset(self, offset: usize) -> Stroke

Returns the Stroke which happens offset Rows after a given start Stroke.

Example

use bellframe::Stroke;

assert_eq!(Stroke::Hand.offset(0), Stroke::Hand);
// The row after a backstroke is a handstroke
assert_eq!(Stroke::Back.offset(1), Stroke::Hand);
assert_eq!(Stroke::Hand.offset(1235124), Stroke::Hand); // Whoa lots of ringing

pub fn offset_i(self, offset: isize) -> Stroke

Returns the Stroke which happens offset Rows after (or before) self.

Example

use bellframe::Stroke;

assert_eq!(Stroke::Hand.offset_i(0), Stroke::Hand);
// The row after a backstroke is a handstroke
assert_eq!(Stroke::Back.offset_i(1), Stroke::Hand);
// The row before a backstroke is also a handstroke
assert_eq!(Stroke::Back.offset_i(-1), Stroke::Hand);
assert_eq!(Stroke::Hand.offset_i(1235124), Stroke::Hand); // Whoa lots of ringing

Trait Implementations

impl Clone for Stroke

fn clone(&self) -> Stroke

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stroke

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

Formats the value using the given formatter.

impl Hash for Stroke

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, 

Feeds a slice of this type into the given Hasher.

impl Not for Stroke

fn not(self) -> Self::Output

Returns the opposite Stroke to self

Example

use bellframe::Stroke;

assert_eq!(!Stroke::Hand, Stroke::Back);
assert_eq!(!Stroke::Back, Stroke::Hand);

type Output = Stroke

The resulting type after applying the ! operator.

impl Ord for Stroke

fn cmp(&self, other: &Stroke) -> 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 where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<Stroke> for Stroke

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

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

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

This method tests for !=.

impl PartialOrd<Stroke> for Stroke

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

impl Eq for Stroke

impl StructuralEq for Stroke

impl StructuralPartialEq for Stroke