Struct Mailbox

pub struct Mailbox { /* private fields */ }

Classic 8x8 square board representation of Chess board. Mailbox is Square-Centric, meaning it indexes by square to get a piece, as opposed to a PieceSets which indexes by piece to get squares. Index starts at A1. A1 = idx 0 B1 = idx 1 A2 = idx 8 H7 = idx 63

Implementations

impl Mailbox

pub const FILES: usize = 8usize

pub const RANKS: usize = 8usize

pub const SIZE: usize = 64usize

pub fn new() -> Self

Creates an empty Mailbox, where all squares are None.

pub fn start_position() -> Self

Create Mailbox with pieces arranged in starting chess position.

pub fn board(&self) -> &[Option<Piece>; 64]

pub fn pretty(&self) -> String

Returns pretty-printed chess board representation of Self. The chess board has borders and file/rank indicators.

Trait Implementations

impl Clone for Mailbox

fn clone(&self) -> Mailbox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mailbox

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

Formats the value using the given formatter.

impl Default for Mailbox

Default value is that of a standard starting chess position.

fn default() -> Self

Returns the “default value” for a type.

impl Display for Mailbox

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

Formats the value using the given formatter.

impl FenComponent for Mailbox

Placement FenComponent.

type Error = ParseFenError

fn try_from_fen_str(s: &str) -> Result<Self, Self::Error>

fn to_fen_str(&self) -> String

impl From<&Mailbox> for PieceSets

fn from(mb: &Mailbox) -> Self

Converts to this type from the input type.

impl From<&PieceSets> for Mailbox

fn from(pieces: &PieceSets) -> Mailbox

Converts to this type from the input type.

impl<I: SquareIndexable> Index<I> for Mailbox

type Output = Option<Piece>

The returned type after indexing.

fn index(&self, idx: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Mailbox

Be careful with accessing with usize, as usize value out of bounds will panic.

type Output = Option<Piece>

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<I: SquareIndexable> IndexMut<I> for Mailbox

fn index_mut(&mut self, idx: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Mailbox

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq for Mailbox

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

impl StructuralPartialEq for Mailbox