Enum pleco::core::File

#[repr(u8)]
pub enum File {
    A,
    B,
    C,
    D,
    E,
    F,
    G,
    H,
}

Enum for the Files of a Chessboard.

Variants

ABCDEFGH

Methods

impl File

pub const fn left_side_mask(self) -> u8

Returns the bit-set of all files to the left of the current file.

pub const fn right_side_mask(self) -> u8

Returns the bit-set of all files to the right of the current file.

pub fn min(self, other: File) -> File

Returns the minimum file.

Examples

use pleco::core::File;

let file_a = File::A;

assert_eq!(file_a.min(File::C), File::A);

pub fn max(self, other: File) -> File

Returns the maximum file.

Examples

use pleco::core::File;

let file_a = File::A;

assert_eq!(file_a.max(File::C), File::C);

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

Returns the distance to another File.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

pub fn bb(self) -> BitBoard

Returns the file BitBoard.

Trait Implementations

impl Copy for File

impl PartialEq<File> for File

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

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

#[must_use]

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

This method tests for !=.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for File

impl PartialOrd<File> for File

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 Clone for File

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 Not for File

type Output = File

The resulting type after applying the ! operator.

fn not(self) -> File

Performs the unary ! operation.