Enum Suit 

pub enum Suit {
    Club = 0,
    Spade = 1,
    Heart = 2,
    Diamond = 3,
}

Indicates the suit of a card.

Suits can be converted from Strings or &strs. The formats for this are the same formats used by Display and Debug. See the descriptions for TryFrom<String> and TryFrom<&str> below for details.

Examples

Parsing suits from strings:

use std::convert::TryFrom;

assert_eq!(Ok(Suit::Club), Suit::try_from("Club"));
assert_eq!(Ok(Suit::Club), Suit::try_from("Clubs"));
assert_eq!(Ok(Suit::Spade), Suit::try_from("spade"));
assert_eq!(Ok(Suit::Heart), Suit::try_from("H"));
assert_eq!(Ok(Suit::Diamond), Suit::try_from("d"));

A formatted suit can be converted back to the original suit:

// Formatted using Display
assert_eq!(Ok(Suit::Club), Suit::try_from(Suit::Club.to_string()));
// Formatted using Debug
assert_eq!(Ok(Suit::Club), Suit::try_from(format!("{:?}", Suit::Club)));

Variants

Club = 0

Spade = 1

Heart = 2

Diamond = 3

Implementations

impl Suit

pub fn colour(self) -> Colour

Returns the colour of this suit.

Club and Spade are black, Heart and Diamond are red.

Examples

use freecell::Colour;

assert_eq!(Colour::Black, Suit::Club.colour());
assert_eq!(Colour::Red, Suit::Heart.colour());

pub fn color(self) -> Color

Returns the color of this suit.

This is an alias of colour()

Trait Implementations

impl Clone for Suit

fn clone(&self) -> Suit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Suit

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

Formats the value using the given formatter.

impl Display for Suit

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

Formats the value using the given formatter.

impl Hash for Suit

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 Suit

fn eq(&self, other: &Suit) -> 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 TryFrom<&str> for Suit

fn try_from(string: &str) -> Result<Suit, Self::Error>

Converts a &str to a Suit.

See the description of TryFrom<String> for details.

type Error = String

The type returned in the event of a conversion error.

impl TryFrom<String> for Suit

fn try_from(string: String) -> Result<Suit, Self::Error>

Converts a String to a Suit.

The string must be one of the following: “Club”, “Clubs”, “C”, “Spade”, “Spades”, “S”, “Heart”, “Hearts”, “H”, “Diamond”, “Diamonds” or “D”. These strings are case-insensitive.

Examples

assert_eq!(Ok(Suit::Club), Suit::try_from(String::from("Club")));
assert_eq!(Ok(Suit::Club), Suit::try_from(String::from("Clubs")));
assert_eq!(Ok(Suit::Club), Suit::try_from(String::from("C")));
assert_eq!(Ok(Suit::Heart), Suit::try_from(String::from("heart")));
assert_eq!(Ok(Suit::Heart), Suit::try_from(String::from("hearts")));
assert_eq!(Ok(Suit::Heart), Suit::try_from(String::from("h")));

type Error = String

The type returned in the event of a conversion error.

impl Copy for Suit

impl Eq for Suit

impl StructuralPartialEq for Suit