Struct Stack 

pub struct Stack { /* private fields */ }

Implementations

impl Stack

pub const fn new(piece: Piece, color: Color) -> Self

Create a new stack with a single piece.

pub fn exact(piece: Piece, colors: Colors) -> Self

Create a new stack with the given colors.

Panics

Panics if the colors are empty.

pub const fn is_empty(&self) -> bool

Check if anything is in this stack. If false, it means the square is empty.

pub const fn size(&self) -> u32

Get the size of the stack.

pub fn top(&self) -> Option<(Piece, Color)>

Get the top piece and color of this stack.

pub const fn colors(&self) -> Colors

pub fn road(&self, color: Color) -> bool

Check if this stack contributes to roads for the given color.

pub fn stack(&mut self, piece: Piece, color: Color) -> Result<(), StackError>

Try to put a piece on top of this stack.

Errors

You cannot stack on top of capstones or walls with the exception that capstones can flatten walls.

pub fn take<const N: usize>( &mut self, amount: u32, ) -> Result<(Piece, Colors), TakeError>

Try taking the top amount pieces from this tile.

Errors

Trying to take 0, more than the carry limit, or more than the stack size will result in an error.

Panics

Should not panic because we check the amount beforehand.

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stack

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

Formats the value using the given formatter.

impl Default for Stack

fn default() -> Stack

Returns the “default value” for a type.

impl Hash for Stack

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 Stack

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

Restrict a value to a certain interval.

impl PartialEq for Stack

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Stack

impl Eq for Stack

impl StructuralPartialEq for Stack