Struct cardpack::Card

pub struct Card {
    pub weight: isize,
    pub index: String,
    pub suit: Suit,
    pub rank: Rank,
}

Card is the core struct in the library. A Card is made up of a Rank, a Suit and weight, which is an integer that controls how a card is sorted in a Pile or as a part of a Vector.

Fields

weight: isize

Used by the Pile struct to sort Cards.

index: String

The identity indicator in the corner of a playing card, such as AS for ace of spades.

suit: Suit

rank: Rank

Implementations

impl Card

pub fn new(rank: &'static str, suit: &'static str) -> Card

Instantiates a new Card with the default weight as defined in the fluent templates.

pub fn new_from_structs(rank: Rank, suit: Suit) -> Card

Instantiates a Card with the weight determined by the passed in Rank and Suit.

pub fn symbol(&self, lid: &LanguageIdentifier) -> String

Returns a Symbol String for the Card.

pub fn symbol_colorized(&self, lid: &LanguageIdentifier) -> String

Returns a Symbol String for the Card in the traditional colors for the Suits.

Trait Implementations

impl Clone for Card

fn clone(&self) -> Card

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Card

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

Formats the value using the given formatter.

impl Default for Card

fn default() -> Card

Returns the "default value" for a type.

impl Display for Card

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

Formats the value using the given formatter.

impl Eq for Card

impl FromIterator<Card> for Pile

fn from_iter<T: IntoIterator<Item = Card>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Card

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 Named for Card

fn name(&self) -> &str

fn index(&self, lid: &LanguageIdentifier) -> String

Returns the value of the names' index in the fluent templates.

fn long(&self, lid: &LanguageIdentifier) -> String

Returns the value of the names' long value in the fluent templates.

fn default_weight(&self) -> isize

Returns the default weight for a name. Weight is used to sort cards.

fn fluent_value(&self, key_section: &str, lid: &LanguageIdentifier) -> String

This is the core method for getting fluent values. the index, long, and default weight methods are all just methods simplifying the call to this method.

fn index_default(&self) -> String

Returns the default, US_ENGLISH value of the names' index value in the fluent templates.

fn long_default(&self) -> String

Returns the default, US_ENGLISH value of the names' long value in the fluent templates.

impl Ord for Card

fn cmp(&self, other: &Card) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Card> for Card

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

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

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

This method tests for !=.

impl PartialOrd<Card> for Card

fn partial_cmp(&self, other: &Card) -> Option<Ordering>

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

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

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

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

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

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

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

fn ge(&self, other: &Card) -> bool

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

impl StructuralEq for Card

impl StructuralPartialEq for Card