Struct tic_tac_toe::board::Board

source ·
pub struct Board { /* private fields */ }
Expand description

A Tic Tac Toe board

Implementations§

source§

impl Board

source

pub fn new() -> Self

Make a new Board.

source

pub fn get_turn(self) -> Team

Get the team whos turn it is.

source

pub fn is_draw(self) -> bool

Returns true if it is a draw.

This does not check for wins.

source

pub fn has_won(self, team: Team) -> bool

Check if the given team won.

This is designed to be fast.

source

pub fn get_winner(self) -> Option<Team>

Get the winner if they exist

source

pub fn get_winner_info(self) -> Option<WinnerInfo>

Get the winner info, if there is a winner

This is much slower than Self::get_winner.

source

pub fn set(self, index: u8, team: Option<Team>) -> Self

Set the tile at the index.

Panics

Panics if the index >= 9.

source

pub fn get(self, index: u8) -> Option<Team>

Get the tile at the index.

Panics

Panics if the index >= 9.

source

pub fn iter_children(self) -> ChildrenIter

Get an iterator over child board states.

Returns

Returns an Iterator where Items are tuples. The first item is the index of the placed tile. The second is the resulting board state.

source

pub fn iter(self) -> impl Iterator<Item = (u8, Option<Team>)>

Get an iterator over the tiles.

The iterator starts at 0 at the top left and ends at 8 at the bottom right.

Returns

Returns a tuple pair, where the first element is the index and the second is the tile value.

source

pub fn encode_u16(self) -> u16

Encode this board as a u16.

source

pub fn decode_u16(data: u16) -> Self

Decode a u16 into a board

Trait Implementations§

source§

impl Clone for Board

source§

fn clone(&self) -> Board

Returns a copy 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 Default for Board

source§

fn default() -> Self

Returns the “default value” for a type. Read more
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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Copy for Board

source§

impl Eq for Board

source§

impl StructuralEq for Board

source§

impl StructuralPartialEq for Board

Auto Trait Implementations§

§

impl RefUnwindSafe for Board

§

impl Send for Board

§

impl Sync for Board

§

impl Unpin for Board

§

impl UnwindSafe for Board

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.