Struct cardpack::cards::card::Card

pub struct Card {
    pub weight: u32,
    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, weight, which is an integer that controls how a card is sorted in a Pile or as a part of a Vector, and index, which is a short String representation of the card, suitable for serialization in text format.

Fields

weight: u32

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: Rank, suit: Suit) -> Self

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

pub fn from_index_strings(rank: &'static str, suit: &'static str) -> Self

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

pub fn to_rank_weight(&self) -> Self

Returns a Card where the sorting emphasizes its Rank weight over its Suit weight. So K♥ A♥ A♠ K♠ would return A♠ A♥ K♠ K♥ instead of A♠ K♠ A♥ K♥.

pub fn shift_rank_weight_left(&self, i: usize) -> Self

Returns a version of the Card, with a geometric Rank weighted operation has been performed on it.

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.

pub fn blank_card() -> Self

👎Deprecated since 0.4.15: Use Card::default()

pub fn count(&self) -> u32

A unique index of a Card relative to other cards in a Pile prioritized by Rank and then by Suit, such that a 2 of spades is lower than a 3 of clubs. While Card.weight prioritizes by Suit and then by Rank.

pub fn is_valid(&self) -> bool

A valid Card is one where the Rank and Suit are not blank. Cards are blank when an invalid Rank or Suit are passed in.

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

Defaults to a blank 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 FromIterator<Card> for Pile

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

Creates a value from an iterator.

impl FromIterator<Card> for Standard52Set

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, Self: Sized,

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) -> u32

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.

fn default_prime(&self) -> u32

impl Ord for Card

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

Restrict a value to a certain interval.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &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 Eq for Card

impl StructuralPartialEq for Card