Enum stockfish_core::core::File

#[repr(u8)]
pub enum File {
    _A,
    _B,
    _C,
    _D,
    _E,
    _F,
    _G,
    _H,
}

A file, A through H, on a chess board. The variants for this enum are prefixed with an underscore to mimic those of Rank.

Variants

_A

_B

_C

_D

_E

_F

_G

_H

Implementations

impl File

pub const COUNT: usize = 8usize

The total number of [$name]s.

pub const VARIANTS: [File; 8] = _

All of the variants of [$name]s, indexable by their discriminant.

pub const NAMES: [&'static str; 8] = _

All of the variant names of [$name], indexable by their discriminant.

pub fn iter() -> IntoIter<Self, { _ }>

Returns an iterator through all [$type] variants.

pub fn name(self) -> &'static str

Returns the name of the variant as a string.

impl File

pub const fn from_fen(byte: u8) -> Option<Self>

Returns a File parsed from a FEN name. None if it isn’t a valid file name.

pub const fn distance(self, other: Self) -> u8

The number of steps it would take a king to move from one file to the other.

Trait Implementations

impl BitAnd<File> for Bitboard

type Output = Bitboard

The resulting type after applying the & operator.

const fn bitand(self, rhs: File) -> Self::Output

Performs the & operation.

impl BitAndAssign<File> for Bitboard

const fn bitand_assign(&mut self, rhs: File)

Performs the &= operation.

impl BitOr<File> for Bitboard

type Output = Bitboard

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<File> for File

type Output = Bitboard

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<File> for Rank

type Output = Square

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<Rank> for File

type Output = Square

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<File> for Bitboard

const fn bitor_assign(&mut self, rhs: File)

Performs the |= operation.

impl BitXor<File> for Bitboard

type Output = Bitboard

The resulting type after applying the ^ operator.

const fn bitxor(self, rhs: File) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<File> for Bitboard

const fn bitxor_assign(&mut self, rhs: File)

Performs the ^= operation.

impl Clone for File

const fn clone(&self) -> File

Returns a copy 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 From<File> for Bitboard

const fn from(f: File) -> Self

Converts to this type from the input type.

impl From<File> for char

const fn from(value: File) -> Self

Converts to this type from the input type.

impl From<File> for u8

const fn from(this: File) -> Self

Converts to this type from the input type.

impl From<File> for usize

const fn from(this: File) -> Self

Converts to this type from the input type.

impl From<Square> for File

const fn from(s: Square) -> Self

Converts to this type from the input type.

impl<T> Index<File> for [T; 8]

type Output = T

The returned type after indexing.

const fn index(&self, val: File) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<File> for [T; 8]

fn index_mut(&mut self, val: File) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for File

type Item = Square

The type of the elements being iterated over.

type IntoIter = IntoIter<Square, 8>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Not for File

type Output = Bitboard

The resulting type after applying the ! operator.

const fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for File

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<File> for File

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

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

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.

impl PartialOrd<File> for File

const 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for File

impl Eq for File

impl StructuralEq for File

impl StructuralPartialEq for File