Enum Square 

pub enum Square {
    A1,
    B1,
    C1,
    D1,
    E1,
    F1,
    G1,
    A2,
    B2,
    C2,
    D2,
    E2,
    F2,
    G2,
    A3,
    B3,
    C3,
    D3,
    E3,
    F3,
    G3,
    A4,
    B4,
    C4,
    D4,
    E4,
    F4,
    G4,
    A5,
    B5,
    C5,
    D5,
    E5,
    F5,
    G5,
    A6,
    B6,
    C6,
    D6,
    E6,
    F6,
    G6,
    A7,
    B7,
    C7,
    D7,
    E7,
    F7,
    G7,
}

Square represents all the squares present on an Ataxx Board. The index of each Square is equal to rank-index * 8 + file-index.

Variants

A1

B1

C1

D1

E1

F1

G1

A2

B2

C2

D2

E2

F2

G2

A3

B3

C3

D3

E3

F3

G3

A4

B4

C4

D4

E4

F4

G4

A5

B5

C5

D5

E5

F5

G5

A6

B6

C6

D6

E6

F6

G6

A7

B7

C7

D7

E7

F7

G7

Implementations

impl Square

pub const N: usize = 49usize

N represents the total number of Squares in an Ataxx Board.

pub fn new(file: File, rank: Rank) -> Square

new creates a new Square from the given File and Rank.

use ataxx::*;

assert_eq!(Square::new(File::A, Rank::First), Square::A1);

pub fn file(self) -> File

file returns the File of the current Square.

use ataxx::*;

assert_eq!(Square::A1.file(), File::A);

pub fn rank(self) -> Rank

rank returns the Rank of the current Square.

use ataxx::*;

assert_eq!(Square::A1.rank(), Rank::First);

pub fn north(self) -> Self

north returns the Square to the North of this one.

use ataxx::*;

assert_eq!(Square::D4.north(), Square::D5);

pub fn south(self) -> Self

south returns the Square to the South of this one.

use ataxx::*;

assert_eq!(Square::D4.south(), Square::D3);

pub fn east(self) -> Self

east returns the Square to the East of this one.

use ataxx::*;

assert_eq!(Square::D4.east(), Square::E4);

pub fn west(self) -> Self

west returns the Square to the West of this one.

use ataxx::*;

assert_eq!(Square::D4.west(), Square::C4);

impl Square

pub fn unsafe_from<T: ToPrimitive>(number: T) -> Self

Trait Implementations

impl BitOr<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the | operator.

fn bitor(self, rhs: Square) -> Self::Output

Performs the | operation.

impl Clone for Square

fn clone(&self) -> Square

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Square

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

Debug implements Debug formatting for a Square. It uses Square::Display behind the hood.

impl Display for Square

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

Display formats the given Square in the format <file><rank>. For how <file> and <rank> are formatted, see the documentation for File::Display and Rank::Display trait implementations.

use ataxx::*;

assert_eq!(Square::A1.to_string(), "a1");

impl From<Square> for BitBoard

fn from(square: Square) -> Self

Converts to this type from the input type.

impl From<Square> for i16

fn from(number: Square) -> Self

Converts to this type from the input type.

impl From<Square> for i32

fn from(number: Square) -> Self

Converts to this type from the input type.

impl From<Square> for i64

fn from(number: Square) -> Self

Converts to this type from the input type.

impl From<Square> for i8

fn from(number: Square) -> Self

Converts to this type from the input type.

impl From<Square> for isize

fn from(number: Square) -> Self

Converts to this type from the input type.

impl From<Square> for u16

fn from(number: Square) -> Self

Converts to this type from the input type.

impl From<Square> for u32

fn from(number: Square) -> Self

Converts to this type from the input type.

impl From<Square> for u64

fn from(number: Square) -> Self

Converts to this type from the input type.

impl From<Square> for u8

fn from(number: Square) -> Self

Converts to this type from the input type.

impl From<Square> for usize

fn from(number: Square) -> Self

Converts to this type from the input type.

impl FromPrimitive for Square

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl FromStr for Square

fn from_str(s: &str) -> Result<Self, Self::Err>

from_str converts a square given in the format <file><rank> into a Square. For the formats of <file> and <rank> see the documentation for File::FromStr and Rank::FromStr. It is effectively the inverse operation of Display.

use ataxx::*;
use std::str::FromStr;

assert_eq!(Square::from_str("a1").unwrap(), Square::A1);

type Err = SquareParseError

The associated error which can be returned from parsing.

impl IntoEnumIterator for Square

type Iterator = SquareIter

fn iter() -> SquareIter

impl PartialEq for Square

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

fn partial_cmp(&self, other: &Square) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the - operator.

fn sub(self, rhs: Square) -> Self::Output

Performs the - operation.

impl TryFrom<i16> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i8> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: i8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Square

type Error = ()

The type returned in the event of a conversion error.

fn try_from(number: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Square

impl StructuralPartialEq for Square