sokoban-elements 0.2.1

Parsing and writing Sokoban, Hexoban, Trioban and Octoban file formats.
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

use std::error::Error;
use std::fmt::{Display, Formatter};

/// Variants of [`PieceIdError`].
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum PieceIdErrorKind {
    InvalidBoxID,
    InvalidGoalID,
    InvalidPusherID,
    InvalidPlusID,
}

/// Errors when working with [`BoxID`](crate::BoxID), [`GoalID`](crate::GoalID) and
/// [`PusherID`](crate::PusherID).
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct PieceIdError {
    pub kind:  PieceIdErrorKind,
    pub value: String,
}

impl PieceIdError {
    pub fn kind(&self) -> PieceIdErrorKind { self.kind }
}

impl Error for PieceIdError {}

impl Display for PieceIdError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match &self.kind {
            PieceIdErrorKind::InvalidBoxID => {
                write!(
                    f,
                    "invalid value {} for BoxID, must be in range 0 .. BoxID::MAX",
                    self.value
                )
            }

            PieceIdErrorKind::InvalidGoalID => {
                write!(
                    f,
                    "invalid value {} for GoalID, must be in range 0 .. GoalID::MAX",
                    self.value
                )
            }

            PieceIdErrorKind::InvalidPusherID => {
                write!(
                    f,
                    "invalid value {} for PusherID, must be in range 0 .. PusherID::MAX",
                    self.value
                )
            }

            PieceIdErrorKind::InvalidPlusID => {
                write!(
                    f,
                    "invalid value {} for PlusID, must be in range 1 .. u16::MAX",
                    self.value
                )
            }
        }
    }
}