Skip to main content

Board

Struct Board 

Source
pub struct Board { /* private fields */ }
Expand description

A snapshot of a board

Construct via Board::try_new, which handles both start-of-trick (use CurrentTrick::new) and mid-trick (0–3 played cards) cases. The invariants below are enforced by the constructor.

§Invariants

  1. remaining is a valid PartialDeal (≤13 cards per hand, pairwise disjoint).
  2. Each card in the current trick is absent from every remaining hand (the “already played” invariant).
  3. Uniform-size-after-restoration: putting the k = current_trick.len() table cards back into their players’ hands yields a subset where all four hands share a common size m. Equivalently, the k seats starting at current_trick.leader() (in playing order: leader, leader.lho(), …) have size m − 1 and the remaining 4 − k seats have size m.

Implementations§

Source§

impl Board

Source

pub fn try_new( remaining: PartialDeal, current_trick: CurrentTrick, ) -> Result<Self, BoardError>

Construct a mid-trick board from a pre-validated CurrentTrick and the cards remaining in each hand.

§Errors

Returns a BoardError if the invariants documented on Board do not hold.

Source

pub const fn trump(&self) -> Strain

Strain of the contract

Source

pub const fn leader(&self) -> Seat

Seat leading the current trick

Source

pub fn current_cards(&self) -> &[Card]

Cards already played to the current trick, in playing order

Source

pub const fn current_trick(&self) -> &CurrentTrick

The current trick — cards played so far plus trump and leader

Source

pub const fn remaining(&self) -> &PartialDeal

Remaining cards in each hand

Trait Implementations§

Source§

impl Clone for Board

Source§

fn clone(&self) -> Board

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Board

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Board> for deal

Source§

fn from(board: Board) -> Self

Converts to this type from the input type.
Source§

impl Hash for Board

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Board

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for Board

Source§

impl StructuralPartialEq for Board

Auto Trait Implementations§

§

impl Freeze for Board

§

impl RefUnwindSafe for Board

§

impl Send for Board

§

impl Sync for Board

§

impl Unpin for Board

§

impl UnsafeUnpin for Board

§

impl UnwindSafe for Board

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.