Enum shogi::time::TimeControl

pub enum TimeControl {
    Byoyomi {
        black_time: Duration,
        white_time: Duration,
        byoyomi: Duration,
    },
    FischerClock {
        black_time: Duration,
        white_time: Duration,
        black_inc: Duration,
        white_inc: Duration,
    },
}

Represents various time controls.

Currently Byo-yomi and Fischer Clock are supported.

Examples

use std::time::Duration;
use shogi::{Color, TimeControl};

let mut byoyomi = TimeControl::Byoyomi{
    black_time: Duration::from_secs(10),
    white_time: Duration::from_secs(10),
    byoyomi: Duration::from_secs(5)
};

// Black player can use the time up to black_time + byoyomi.
byoyomi.consume(Color::Black, Duration::from_secs(15));
assert_eq!(Duration::from_secs(0), byoyomi.black_time());
assert_eq!(Duration::from_secs(10), byoyomi.white_time());

use std::time::Duration;
use shogi::{Color, TimeControl};

let mut fischer_clock = TimeControl::FischerClock{
    black_time: Duration::from_secs(10),
    white_time: Duration::from_secs(10),
    black_inc: Duration::from_secs(1),
    white_inc: Duration::from_secs(1)
};

// White player gets additional 1 second after the black move.
fischer_clock.consume(Color::Black, Duration::from_secs(3));
assert_eq!(Duration::from_secs(8), fischer_clock.black_time());
assert_eq!(Duration::from_secs(10), fischer_clock.white_time());

Variants

Byoyomi

Fields

black_time: Duration

white_time: Duration

byoyomi: Duration

FischerClock

Fields

black_time: Duration

white_time: Duration

black_inc: Duration

white_inc: Duration

Implementations

impl TimeControl

pub fn black_time(&self) -> Duration

Returns the current remaining time for the black player.

pub fn white_time(&self) -> Duration

Returns the current remaining time for the white player.

pub fn consume(&mut self, c: Color, d: Duration) -> bool

Updates the current remaining time after consuming the given amount of time for the given player.

Returns false if the given player runs out of time, true otherwise.

Examples

use std::time::Duration;
use shogi::{Color, TimeControl};

let mut byoyomi = TimeControl::Byoyomi{
    black_time: Duration::from_secs(10),
    white_time: Duration::from_secs(10),
    byoyomi: Duration::from_secs(5)
};

assert!(byoyomi.consume(Color::Black, Duration::from_secs(15)));
assert!(!byoyomi.consume(Color::White, Duration::from_secs(20)));

Trait Implementations

impl Clone for TimeControl

fn clone(&self) -> TimeControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeControl

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

Formats the value using the given formatter.

impl Copy for TimeControl