Struct Field

pub struct Field { /* private fields */ }

Represents a board location in a chess game.

Implementations

impl Field

pub const fn new(column: u8, row: u8) -> Option<Self>

Creates a field from a column and a row. Both values must be between 0-7 or None will be returned. For easy usage use the board constants as arguments (Board::)

pub fn new_from_usize(column: usize, row: usize) -> Option<Self>

Converts two usize params into a field.

• column - The column of the new field
• row - The row of the new field
• returns - A field containing the column and row parameters

pub fn new_from_string(field: &str) -> Option<Self>

Converts a field from a string into the field data type if possible. The string has to follow the format: column + row. Example: a3.

• field - The string which should be converted into a Field object
• returns - A Field object

pub fn set_column(&mut self, column: u8)

Sets the column of the field. The given value must be between 0-7 (inclusive). Otherwise the value will be ignored.

pub fn set_row(&mut self, row: u8)

Sets the row of the field. The given value must be between 0-7 (inclusive). Otherwise the value will be ignored.

pub fn get_column(&self) -> u8

Returns the column of the field.

pub fn get_row(&self) -> u8

Returns the row of the field.

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Display for Field

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

Formats the value using the given formatter.

impl PartialEq for Field

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

Tests for self and other values to be equal, and is used by ==.

const 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 Copy for Field

impl Eq for Field

impl StructuralPartialEq for Field