Enum pgn_reader::File

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

A file of the chessboard.

Variants

A

B

C

D

E

F

G

H

Implementations

impl File

pub const fn new(index: u32) -> File

Gets a File from an integer index.

Panics

Panics if the index is not in the range 0..=7.

pub const unsafe fn new_unchecked(index: u32) -> File

Gets a File from an integer index.

Safety

It is the callers responsibility to ensure the index is in the range 0..=7.

pub fn from_char(ch: char) -> Option<File>

pub fn char(self) -> char

pub fn upper_char(self) -> char

pub fn offset(self, delta: i32) -> Option<File>

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

pub fn flip_horizontal(self) -> File

pub fn flip_diagonal(self) -> Rank

pub fn flip_anti_diagonal(self) -> Rank

pub const ALL: [File; 8] = [File::A, File::B, File::C, File::D, File::E, File::F, File::G, File::H]

A, …, H.

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<(), Error>

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

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

Feeds this value into the given Hasher.

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

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

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) -> Selfwhere
    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 Sub<File> for File

type Output = i32

The resulting type after applying the - operator.

fn sub(self, other: File) -> i32

Performs the - operation.

impl TryFrom<i16> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<File, <File as TryFrom<i16>>::Error>

Performs the conversion.

impl TryFrom<i32> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<File, <File as TryFrom<i32>>::Error>

Performs the conversion.

impl TryFrom<i64> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<File, <File as TryFrom<i64>>::Error>

Performs the conversion.

impl TryFrom<i8> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<File, <File as TryFrom<i8>>::Error>

Performs the conversion.

impl TryFrom<isize> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<File, <File as TryFrom<isize>>::Error>

Performs the conversion.

impl TryFrom<u16> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<File, <File as TryFrom<u16>>::Error>

Performs the conversion.

impl TryFrom<u32> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<File, <File as TryFrom<u32>>::Error>

Performs the conversion.

impl TryFrom<u64> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<File, <File as TryFrom<u64>>::Error>

Performs the conversion.

impl TryFrom<u8> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<File, <File as TryFrom<u8>>::Error>

Performs the conversion.

impl TryFrom<usize> for File

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<File, <File as TryFrom<usize>>::Error>

Performs the conversion.

impl Copy for File

impl Eq for File

impl StructuralEq for File

impl StructuralPartialEq for File