Struct cardpack::Rank

pub struct Rank {
    pub weight: isize,
    pub name: FluentName,
}

Rank Struct for a Card. Examples of standard Card Ranks would include: Ace, Ten, and Deuce Joker, Death (Tarot), and Ober (Skat). The weight of the Rank determines how a Card is sorted relative to it's Suit.

There are four ways to instantiate a Rank, each of them having advantages:

As an instance variable

let ace = cardpack::Rank {
    weight: 1,
    name: cardpack::fluent_name::FluentName::new(cardpack::ACE),
};

This gives you maximum flexibility. Since the value of the Ace is 1, it will be sorted at the and of a Suit (unless there are any Cards with negative weights).

Rank::new() with a value string

let king = cardpack::Rank::new(cardpack::KING);

This sets the weight for the Rank based upon the default value as set in its fluent template entry.

Rank::new_with_weight()

let king = cardpack::Rank::new_with_weight(cardpack::QUEEN, 12);

Overrides the default weight for a Rank.

Rank::from_array()

let ranks: Vec<cardpack::Rank> = cardpack::Rank::from_array(&[cardpack::ACE, cardpack::TEN,]);

Returns a Vector of Ranks with their weights determined by the order they're passed in, high to low. This facilitates the easy creation of custom decks, such as pinochle.

Fields

weight: isize

Used by the Pile struct to sort Cards by their Suit and Rank.

name: FluentName

Implementations

impl Rank

pub fn new(name: &'static str) -> Rank

Returns a Rank, determining its weight by the default weight value for its name set in the fluent templates. For instance, if you look in `src/fluent/locales/core.ftl you will see that the default weight for an Ace is 14. This will mean that when a pile of cards is sorted that it will be at the top of a standard French Deck where the Ace is high.

Usage

let king = cardpack::Rank::new(cardpack::HERMIT);

pub fn new_with_weight(name: &'static str, weight: isize) -> Rank

Returns a Rank instance with the passed in name and weight, overriding the default value set in the fluent templates.

Usage

let king = cardpack::Rank::new_with_weight(cardpack::QUEEN, 12);

pub fn from_array(s: &[&'static str]) -> Vec<Rank>

Usage

let ranks: Vec<cardpack::Rank> = cardpack::Rank::from_array(&[
    cardpack::ACE, cardpack::TEN, cardpack::KING,
    cardpack::QUEEN, cardpack::JACK, cardpack::NINE]);

Returns a Vector of Ranks with their weights determined by the order they're passed in, high to low. This facilitates the easy creation of custom decks, such as for pinochle.

pub fn generate_canasta_ranks() -> Vec<Rank>

pub fn generate_euchre_ranks() -> Vec<Rank>

pub fn generate_french_ranks() -> Vec<Rank>

pub fn generate_pinochle_ranks() -> Vec<Rank>

pub fn generate_major_arcana_ranks() -> Vec<Rank>

pub fn generate_minor_arcana_ranks() -> Vec<Rank>

pub fn generate_skat_ranks() -> Vec<Rank>

Trait Implementations

impl Clone for Rank

fn clone(&self) -> Rank

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Rank

impl Debug for Rank

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

Formats the value using the given formatter.

impl Default for Rank

fn default() -> Rank

Returns the "default value" for a type.

impl Display for Rank

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

Formats the value using the given formatter.

impl Eq for Rank

impl Hash for Rank

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 Rank

fn name(&self) -> &str

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(&self, lid: &LanguageIdentifier) -> String

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

fn index_default(&self) -> String

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

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

Returns the value of the names' long 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_weight(&self) -> isize

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

impl Ord for Rank

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

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

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

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

This method tests for !=.

impl PartialOrd<Rank> for Rank

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Rank

impl StructuralPartialEq for Rank