Struct Pile 

pub struct Pile<T> { /* private fields */ }

An ordered pile of items with deterministic operations.

The “top” is the end of the pile: draw takes from the top and put adds to it. Shuffling is deterministic given a Prng, and the pile carries no generator of its own, so it snapshots and replays with whatever state it lives in. This is an opt-in helper; a game’s State can hold piles or plain fields as it prefers.

Implementations

impl<T> Pile<T>

pub const fn new() -> Self

Creates an empty pile.

pub const fn from_items(items: Vec<T>) -> Self

Creates a pile from items, with the last element on top.

pub const fn len(&self) -> usize

Returns the number of items.

pub const fn is_empty(&self) -> bool

Returns true if the pile is empty.

pub fn draw(&mut self) -> Option<T>

Removes and returns the top item, or None if empty.

pub fn draw_n(&mut self, n: usize) -> Vec<T>

Removes up to n items from the top, returned top-first.

pub fn put(&mut self, item: T)

Adds an item to the top.

pub fn put_bottom(&mut self, item: T)

Adds an item to the bottom.

pub fn insert(&mut self, index: usize, item: T)

Inserts an item at index (clamped to the length), preserving order.

Use this to reverse a draw exactly, e.g. in a Reversible undo.

pub fn remove(&mut self, index: usize) -> Option<T>

Removes and returns the item at index, or None if out of range.

pub fn shuffle(&mut self, rng: &mut Prng)

Shuffles the pile in place with a deterministic Fisher-Yates using rng.

pub fn as_slice(&self) -> &[T]

Returns the items, bottom to top.

pub fn iter(&self) -> Iter<'_, T>

Iterates the items, bottom to top.

impl<T: PartialEq> Pile<T>

pub fn contains(&self, item: &T) -> bool

Returns true if the pile contains item.

pub fn position(&self, item: &T) -> Option<usize>

Returns the index of the first item equal to item, or None.

pub fn remove_item(&mut self, item: &T) -> Option<T>

Removes and returns the first item equal to item, or None.

Trait Implementations

impl<T: Clone> Clone for Pile<T>

fn clone(&self) -> Pile<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Pile<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Pile<T>

fn default() -> Pile<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Pile<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> FromIterator<T> for Pile<T>

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

Creates a value from an iterator.

impl<'a, T> IntoIterator for &'a Pile<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for Pile<T>

fn eq(&self, other: &Pile<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for Pile<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Pile<T>

impl<T> StructuralPartialEq for Pile<T>