Struct onejoker::poker::hand_value::HandDescription

#[repr(C)]
pub struct HandDescription {
    pub hand: Hand,
    pub value: HandValue,
    pub scale: Scale,
    pub level: HandLevel,
    pub length: u8,
    pub extras: HandExtras,
}

wiki | Info about an evaluated hand

Describes all the information about a hand after evaluation.

Fields

hand: Hand

Copy of the hand under evaluation. Modified during evaluation.

value: HandValue

Comparison value: lower is better

scale: Scale

Which game type we are evaluating for

level: HandLevel

Level of the hand

length: u8

“Meaningful” length

extras: HandExtras

Extra game-specific information about the hand

Implementations

impl HandDescription

pub fn from_value(hand: &Hand, scale: Scale, value: HandValue) -> Self

Create a new HandDescription object from HandValue

pub fn full_text(&self) -> String

Full english description, e.g. “aces full of kings”

pub fn hand_to_string(&self) -> String

Print relevant part of hand

pub fn add_bugs(&mut self, bugs: [Card; 2])

Add bug replacement values

Trait Implementations

impl Clone for HandDescription

fn clone(&self) -> HandDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HandDescription

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

Formats the value using the given formatter.

impl Default for HandDescription

fn default() -> Self

Returns the “default value” for a type.

impl Display for HandDescription

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

Formats the value using the given formatter.

impl Hash for HandDescription

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 Ord for HandDescription

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

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

fn partial_cmp(&self, other: &Self) -> 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 Copy for HandDescription

impl Eq for HandDescription