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
46
47
48

use std::fmt::{Debug, Display, Formatter};

/// View state of a field.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub enum View {
    /// The field has not been visited yet and is covered.
    #[default]
    Covered,
    /// The field is flagged.
    Flag,
    /// The player stepped onto a dud.
    SteppedOnDud,
    /// The player stepped onto a live mine.
    SteppedOnMine,
    /// The field is clear.
    Clear {
        /// The amount of mines adjacent to the field.
        adjacent_mines: u8,
    },
    /// The field contains a mine.
    Mine,
}

impl View {
    /// Returns a char representation of the field's view.
    #[allow(clippy::missing_panics_doc)]
    #[must_use]
    pub const fn as_char(self) -> char {
        match self {
            Self::Covered => '■',
            Self::Flag => '⚐',
            Self::SteppedOnDud => '~',
            Self::SteppedOnMine => '☠',
            Self::Clear { adjacent_mines } => match adjacent_mines {
                0 => ' ',
                mines => char::from_digit(mines as u32, 10)
                    .expect("Amount of adjacent mines should be a single decimal digit."),
            },
            Self::Mine => '*',
        }
    }
}

impl Display for View {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        Display::fmt(&self.as_char(), f)
    }
}