spru 0.1.0

Reusable components for the spru strategy and digital board game framework.
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! Errors encountered while applying [Action](trait@super::Action)s.

use std::{fmt, ops};

use crate::{
    common::error::{AnyError, PsuedoError},
    item::{self, storage},
};

/// An error encountered while applying an [trait@super::Action].
/// [std::ops::Deref] to use as a [std::error::Error].
#[derive(Debug)]
pub struct Error {
    kind: Kind,
    context: Option<Context>,
}

impl Error {
    pub(crate) fn new(kind: Kind) -> Self {
        Self {
            kind,
            context: None,
        }
    }

    pub(crate) fn new_item(item_error: item::Error) -> Self {
        Self::new(Kind::Item(item_error))
    }

    pub(crate) fn with_context<Action: ?Sized>(mut self, action: &Action) -> Self {
        self.context = Some(Context::new(action));
        self
    }

    /// The contained inner error
    pub fn kind(&self) -> &Kind {
        &self.kind
    }
}

impl ops::Deref for Error {
    type Target = dyn std::error::Error;

    fn deref(&self) -> &Self::Target {
        self.as_error()
    }
}

impl From<storage::Error> for Error {
    fn from(value: storage::Error) -> Self {
        Self::new(Kind::Storage(value))
    }
}

impl<E: Into<AnyError>> From<E> for Error {
    fn from(value: E) -> Self {
        Self::new(Kind::Action(value.into()))
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let Self { kind, context } = self;

        if let Some(context) = context {
            write!(f, "{context}")?;
        } else {
            write!(f, "Action")?;
        }
        write!(f, " failed: {kind}")?;

        Ok(())
    }
}

impl PsuedoError for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match &self.kind {
            Kind::Storage(e) => std::error::Error::source(e.as_error()),
            Kind::Item(e) => std::error::Error::source(e),
            Kind::Action(e) => std::error::Error::source(e.as_error()),
        }
    }
}

#[derive(Debug)]
pub(crate) struct Context {
    action_name: &'static str,
}

impl Context {
    pub(crate) fn new<Action: ?Sized>(_action: &Action) -> Self {
        Self {
            action_name: std::any::type_name::<Action>(),
        }
    }
}

impl fmt::Display for Context {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let Self { action_name } = self;

        write!(f, "Action '{action_name}'")?;

        Ok(())
    }
}

/// The inner error contained in the [Error]
#[derive(Debug)]
pub enum Kind {
    /// A [storage::Error]
    Storage(storage::Error),
    /// An [item::Error]
    Item(item::Error),
    /// A user-provided error
    Action(AnyError),
}

impl fmt::Display for Kind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Kind::Storage(e) => fmt::Display::fmt(e, f),
            Kind::Item(e) => fmt::Display::fmt(e, f),
            Kind::Action(e) => fmt::Display::fmt(e, f),
        }
    }
}