Enum File 

pub enum File {
    A,
    B,
    C,
    D,
    E,
    F,
    G,
    H,
}

A file on a chessboard.

Variants

A

The A file.

B

The B file.

C

The C file.

D

The D file.

E

The E file.

F

The F file.

G

The G file.

H

The H file.

Implementations

impl File

pub const NUM: usize = 8usize

The number of File variants.

pub const ALL: [Self; 8]

An array of all File variants.

pub const fn try_index(index: usize) -> Option<Self>

Checked version of File::index.

pub fn index(index: usize) -> Self

Convert an index to a File.

Panics

Panic if the index is out of bounds.

pub const fn index_const(index: usize) -> Self

const version of File::index.

Panics

Panic if the index is out of bounds.

impl File

pub const fn flip(self) -> Self

Flip the file.

Examples

assert_eq!(File::A.flip(), File::H);

pub const fn bitboard(self) -> BitBoard

Get a bitboard with all squares on this file set.

Examples

assert_eq!(File::B.bitboard(), bitboard! {
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
});

pub const fn adjacent(self) -> BitBoard

Get a bitboard with all squares on adjacent files set.

Examples

assert_eq!(File::C.adjacent(), bitboard! {
    . X . X . . . .
    . X . X . . . .
    . X . X . . . .
    . X . X . . . .
    . X . X . . . .
    . X . X . . . .
    . X . X . . . .
    . X . X . . . .
});
assert_eq!(File::A.adjacent(), bitboard! {
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
    . X . . . . . .
});
assert_eq!(File::H.adjacent(), bitboard! {
    . . . . . . X .
    . . . . . . X .
    . . . . . . X .
    . . . . . . X .
    . . . . . . X .
    . . . . . . X .
    . . . . . . X .
    . . . . . . X .
});

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Display for File

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

Formats the value using the given formatter.

impl From<File> for BitBoard

fn from(value: File) -> Self

Converts to this type from the input type.

impl From<File> for char

fn from(value: File) -> Self

Converts to this type from the input type.

impl FromStr for File

type Err = FileParseError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for File

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for File

fn cmp(&self, other: &File) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for File

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

fn partial_cmp(&self, other: &File) -> 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 TryFrom<char> for File

type Error = FileParseError

The type returned in the event of a conversion error.

fn try_from(value: char) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for File

impl Eq for File

impl StructuralPartialEq for File