Struct bitboard_xo::xo_pos::XOPos

pub struct XOPos { /* fields omitted */ }

Position in xo-grid

Methods

impl XOPos

pub fn index(index: u32) -> Result<Self, XOPosError>

Create XOPos from index, starting 0 at top left corner and counting up in book reading direction (see grid below)

Index grid:

| 0 | 1 | 2 |
| 3 | 4 | 5 |
| 6 | 7 | 8 |

Error

If invalid index is passed in (index >= 9), the error variant XOPosError::InvalidXOIndex will be returned

pub fn row_col(row: u32, col: u32) -> Result<Self, XOPosError>

Create XOPos from (row, column) position.

(row, column) grid:

| 0,0 | 0,1 | 0,2 |
| 1,0 | 1,1 | 1,2 |
| 2,0 | 2,1 | 2,2 |

Error

If invalid row (row >= 3) or column (column >= 3) is passed in, the error variant XOPosError::InvalidXORow or XOPosError::InvalidXOCol will be returned correspondingly

pub fn col_row(col: u32, row: u32) -> Result<Self, XOPosError>

Create XOPos from (column, row) position

(column, row) grid:

| 0,0 | 1,0 | 2,0 |
| 0,1 | 1,1 | 2,1 |
| 0,2 | 1,2 | 2,2 |

Error

If invalid row (row >= 3) or column (column >= 3) is passed in, the error variant XOPosError::InvalidXORow or XOPosError::InvalidXOCol will be returned correspondingly

pub fn as_index(self) -> u32

Retrieve index inside this XOPos, guaranteed to be one of 0,1,2,3,4,5,6,7,8

Index grid:

| 0 | 1 | 2 |
| 3 | 4 | 5 |
| 6 | 7 | 8 |

Trait Implementations

impl Clone for XOPos

fn clone(&self) -> XOPos

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for XOPos

impl Debug for XOPos

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

Formats the value using the given formatter.

impl TryFrom<u32> for XOPos

type Error = XOPosError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, XOPosError>

Performs the conversion.