Struct LedPattern 

pub struct LedPattern { /* private fields */ }

LED colors for all 64 squares in canonical A1-to-H8 order.

Pass a pattern to Command::set_leds to create the command written to the board.

Implementations

impl LedPattern

pub const fn new(squares: [LedColor; 64]) -> Self

Creates a pattern from LedColors in canonical A1-to-H8 order.

Index zero controls A1 and index 63 controls H8.

Examples

use chessnut_move::protocol::{LedColor, LedPattern, SQUARE_COUNT};

let pattern = LedPattern::new([LedColor::Red; SQUARE_COUNT]);
assert_eq!(pattern, LedPattern::all(LedColor::Red));

pub const fn all(color: LedColor) -> Self

Creates a pattern with the same LedColor on every square.

Examples

use chessnut_move::protocol::{File, LedColor, LedPattern, Rank, Square};

let pattern = LedPattern::all(LedColor::Green);
assert_eq!(
    pattern.color_at(Square::new(File::H, Rank::Eight)),
    LedColor::Green,
);

pub const fn color_at(&self, square: Square) -> LedColor

Returns the selected LedColor for a square.

Examples

use chessnut_move::protocol::{File, LedColor, LedPattern, Rank, Square};

let pattern = LedPattern::all(LedColor::Blue);
assert_eq!(
    pattern.color_at(Square::new(File::A, Rank::One)),
    LedColor::Blue,
);

pub fn set_color(&mut self, square: Square, color: LedColor)

Replaces the selected LedColor for one square.

Examples

use chessnut_move::protocol::{File, LedColor, LedPattern, Rank, Square};

let square = Square::new(File::D, Rank::Five);
let mut pattern = LedPattern::default();
pattern.set_color(square, LedColor::Red);
assert_eq!(pattern.color_at(square), LedColor::Red);

Trait Implementations

impl Clone for LedPattern

fn clone(&self) -> LedPattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LedPattern

impl Debug for LedPattern

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

Formats the value using the given formatter.

impl Default for LedPattern

fn default() -> Self

Returns the “default value” for a type.

impl Eq for LedPattern

impl Hash for LedPattern

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 PartialEq for LedPattern

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LedPattern