Enum Strain 

#[repr(u8)]
pub enum Strain {
    Clubs = 0,
    Diamonds = 1,
    Hearts = 2,
    Spades = 3,
    Notrump = 4,
}

Denomination, a suit or notrump

We choose this representation over Option<Suit> because we are not sure if the latter can be optimized to a single byte.

The order of the suits deviates from dds, but this order provides natural ordering by deriving PartialOrd and Ord.

Variants

Clubs = 0

♣

Diamonds = 1

♦

Hearts = 2

♥

Spades = 3

♠

Notrump = 4

NT, the strain not proposing a trump suit

Implementations

impl Strain

pub const ASC: [Self; 5]

Strains in the ascending order, the order in this crate

pub const DESC: [Self; 5]

Strains in the descending order

pub const SYS: [Self; 5]

Strains in the order in dds_bridge_sys

pub const fn is_minor(self) -> bool

Whether this strain is a minor suit (clubs or diamonds)

pub const fn is_major(self) -> bool

Whether this strain is a major suit (hearts or spades)

pub const fn is_suit(self) -> bool

Whether this strain is a suit

pub const fn is_notrump(self) -> bool

Whether this strain is notrump

Trait Implementations

impl Clone for Strain

fn clone(&self) -> Strain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Strain

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

Formats the value using the given formatter.

impl From<Suit> for Strain

fn from(suit: Suit) -> Self

Converts to this type from the input type.

impl Hash for Strain

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 Index<Strain> for TricksTable

type Output = TricksRow

The returned type after indexing.

fn index(&self, strain: Strain) -> &TricksRow

Performs the indexing (container[index]) operation.

impl Ord for Strain

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

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

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

type Error = SuitFromNotrumpError

The type returned in the event of a conversion error.

fn try_from(strain: Strain) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Strain

impl Eq for Strain

impl StructuralPartialEq for Strain