Enum Rank

pub enum Rank {
    One,
    Two,
    Three,
    Four,
    Five,
    Six,
    Seven,
    Eight,
}

The rank component of a chess position.

Variants

One

Two

Three

Four

Five

Six

Seven

Eight

Implementations

impl Rank

pub fn up(self) -> Option<Self>

Get the Rank above self, or None if no such rank exists.

Example

assert_eq!(Rank::One.up(), Some(Rank::Two));
assert_eq!(Rank::Eight.up(), None);

pub fn walk_up(self) -> impl Iterator<Item = Self>

Returns an iterator over the ranks above, and including self.

Example

let up: Vec<Rank> = Rank::Six.walk_up().collect();
assert_eq!(up, vec![Rank::Six, Rank::Seven, Rank::Eight]);

pub fn down(self) -> Option<Self>

Get the Rank below self, or None if no such rank exists.

Example

assert_eq!(Rank::Seven.down(), Some(Rank::Six));
assert_eq!(Rank::One.down(), None);

pub fn walk_down(self) -> impl Iterator<Item = Self>

Returns an iterator over the ranks below, and including self.

Example

let down: Vec<Rank> = Rank::Three.walk_down().collect();
assert_eq!(down, vec![Rank::Three, Rank::Two, Rank::One]);

pub fn iter(self) -> impl DoubleEndedIterator<Item = Position>

Create an iterator over all positions in the Rank, in ascending order.

Example

let ranks: Vec<Position> = Rank::Four.iter().collect();
assert_eq!(ranks, vec![A4, B4, C4, D4, E4, F4, G4, H4]);

Trait Implementations

impl Clone for Rank

fn clone(&self) -> Rank

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rank

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

Formats the value using the given formatter.

impl Display for Rank

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

Formats the value using the given formatter.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Rank

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Rank

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Rank

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Rank

impl Eq for Rank

impl StructuralPartialEq for Rank