Enum chess::Rank

pub enum Rank {
    First,
    Second,
    Third,
    Fourth,
    Fifth,
    Sixth,
    Seventh,
    Eighth,
}

Describe a rank (row) on a chess board

Variants

First

Second

Third

Fourth

Fifth

Sixth

Seventh

Eighth

Methods

impl Rank

pub fn from_index(i: usize) -> Rank

Convert a usize into a Rank (the inverse of to_index). If the number is > 7, wrap around.

pub fn down(&self) -> Rank

Go one rank down. If impossible, wrap around.

pub fn up(&self) -> Rank

Go one file up. If impossible, wrap around.

pub fn to_index(&self) -> usize

Convert this Rank into a usize between 0 and 7 (inclusive).

Trait Implementations

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 Copy for Rank

impl Debug for Rank

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

Formats the value using the given formatter.

impl FromStr for Rank

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for Rank

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

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 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 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 StructuralPartialEq for Rank