Enum pgn_reader::Rank

#[repr(i8)]
pub enum Rank {
    First,
    Second,
    Third,
    Fourth,
    Fifth,
    Sixth,
    Seventh,
    Eighth,
}

A rank of the chessboard.

Variants

FirstSecondThirdFourthFifthSixthSeventhEighth

Methods

impl Rank

pub fn new(index: i8) -> Rank

Gets a Rank from an integer index.

Panics

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

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

pub fn from_index(index: i8) -> Option<Rank>

pub unsafe fn from_index_unchecked(index: i8) -> Rank

Gets a Rank from an integer index.

Unsafety

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

pub fn char(self) -> char

pub fn flip_diagonal(self) -> File

pub fn offset(self, delta: i8) -> Option<Rank>

pub fn flip_vertical(self) -> Rank

Trait Implementations

impl PartialEq<Rank> for Rank

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

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

Formats the value using the given formatter.

impl Clone for Rank

fn clone(&self) -> Rank

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Rank> for Rank

fn partial_cmp(&self, other: &Rank) -> 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 Debug for Rank

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

Formats the value using the given formatter.

impl Copy for Rank

impl Sub<Rank> for Rank

type Output = i8

The resulting type after applying the - operator.

fn sub(self, other: Rank) -> i8

Performs the - operation.

impl Eq for Rank

impl TryFrom<i64> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f64> for Rank

type Error = TryFromFloatError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Rank, <Rank as TryFrom<f64>>::Error>

Performs the conversion.

impl TryFrom<i8> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i32> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f32> for Rank

type Error = TryFromFloatError

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Rank, <Rank as TryFrom<f32>>::Error>

Performs the conversion.

impl TryFrom<isize> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u32> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u128> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Rank, <Rank as TryFrom<u128>>::Error>

Performs the conversion.

impl TryFrom<usize> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u16> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i16> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i128> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Rank, <Rank as TryFrom<i128>>::Error>

Performs the conversion.

impl TryFrom<u8> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u64> for Rank

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Hash for Rank

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 Rank

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

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.