rustymines 2.6.2

A mine sweeping game engine with optional duds.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

use std::time::Instant;

/// Represents the outcome of a game.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub struct Outcome {
    /// Flag whether the game was won.
    won: bool,
    /// Time when the game ended.
    end: Instant,
}

impl Outcome {
    /// Crate a new instance of a game outcome.
    #[must_use]
    pub(crate) fn new(won: bool) -> Self {
        Self {
            won,
            end: Instant::now(),
        }
    }

    /// Crate a new outcome for a win.
    #[must_use]
    pub(crate) fn won() -> Self {
        Self::new(true)
    }

    /// Crate a new outcome for a loss.
    #[must_use]
    pub(crate) fn lost() -> Self {
        Self::new(false)
    }

    /// Returns `true` if the game is won, else `false`.
    #[must_use]
    pub const fn is_won(self) -> bool {
        self.won
    }

    /// Returns the instant when the game ended.
    #[must_use]
    pub const fn end(self) -> Instant {
        self.end
    }
}