Enum chess::File

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

Describe a file (column) on a chess board.

Variants

A

B

C

D

E

F

G

H

Implementations

impl File

pub fn new(index: usize) -> Self

Gets a File from an integer index.

Note: If index is not in the range 0..=7, wrap around.

pub fn to_index(&self) -> usize

Convert this File into a usize between 0 and 7 inclusive.

pub fn left(&self) -> Self

Go one file to the left.

Note: If impossible, wrap around.

pub fn right(&self) -> Self

Go one file to the right.

Note: If impossible, wrap around.

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

Distance between two File.

pub fn between(&self, lower_bound: File, upper_bound: File) -> bool

Verify if the File is between two other (i.e. lower <= self <= upper).

Assume that lower_bound <= upper_bound.

Trait Implementations

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

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

Only lowercase from a to h (inclusive).

type Err = Error

The associated error which can be returned from parsing.

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 where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

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 ==.

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

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