Struct stochasta::CardDrawSequence

pub struct CardDrawSequence<C>
where
    C: Eq + Hash,
{ /* private fields */ }

A representation of a sequence of drawn cards.

Type Parameters

• C: The type of a single card

See also

• CardDrawTree::paths

Implementations

impl<C> CardDrawSequence<C>

where C: Eq + Hash,

pub fn new(cards: Vec<C>, probability: Probability) -> Self

Creates a new CardDrawSequence with the given values.

Example

use stochasta::{CardDrawSequence, PROBABILITY_ONE};

let sequence = CardDrawSequence::new(vec![1, 2, 3], PROBABILITY_ONE);
assert_eq!(sequence.cards(), &vec![1, 2, 3]);
assert_eq!(sequence.probability(), &PROBABILITY_ONE);

pub fn cards(&self) -> &Vec<C>

Returns the cards as they appear in their sequence.

pub fn probability(&self) -> &Probability

Returns the probability of this sequence to appear.

Trait Implementations

impl<C> Clone for CardDrawSequence<C>

where C: Eq + Hash + Clone,

fn clone(&self) -> CardDrawSequence<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for CardDrawSequence<C>

where C: Eq + Hash + Debug,

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

Formats the value using the given formatter.

impl<C> Default for CardDrawSequence<C>

where C: Eq + Hash + Default,

fn default() -> CardDrawSequence<C>

Returns the “default value” for a type.

impl<'de, C> Deserialize<'de> for CardDrawSequence<C>

where C: Eq + Hash + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> Display for CardDrawSequence<C>

where C: Eq + Hash + Debug + Display,

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

Formats the value using the given formatter.

impl<C> Hash for CardDrawSequence<C>

where C: Eq + Hash + Hash,

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<C> Ord for CardDrawSequence<C>

where C: Eq + Hash + Ord,

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

where C: Eq + Hash + PartialEq,

fn eq(&self, other: &CardDrawSequence<C>) -> 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<C> PartialOrd for CardDrawSequence<C>

where C: Eq + Hash + PartialOrd,

fn partial_cmp(&self, other: &CardDrawSequence<C>) -> 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<C> Serialize for CardDrawSequence<C>

where C: Eq + Hash + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C> Eq for CardDrawSequence<C>

where C: Eq + Hash + Eq,

impl<C> StructuralPartialEq for CardDrawSequence<C>

where C: Eq + Hash,