erratic 0.12.0

Handling errors in an efficient way.
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

//! State traits and the [`Stateless`] marker.
use core::{convert::Infallible, fmt::Debug, marker::PhantomData, result};

use crate::{Error, raw::RawVacant};

/// Associates an error state type with its stored representation.
///
/// Most types implement `State::Repr = Self` via blanket impl.
pub trait State: Debug + Send + Sync + 'static {
    /// The type used to store the state inside [`Error`](crate::Error).
    type Repr: Debug + Send + Sync + 'static;

    /// Converts `self` into its stored representation.
    fn into_repr(self) -> Self::Repr
    where
        Self: Sized;

    /// Recovers the state from its stored representation.
    fn from_repr(state: Self::Repr) -> Self
    where
        Self: Sized;

    /// Recovers a reference to the state from a reference to its stored representation.
    fn from_repr_ref(state: &Self::Repr) -> &Self
    where
        Self: Sized;
}

impl<T> State for T
where
    T: Debug + Send + Sync + 'static,
{
    type Repr = T;

    fn into_repr(self) -> Self::Repr {
        self
    }

    fn from_repr(this: Self::Repr) -> Self
    where
        Self: Sized,
    {
        this
    }

    fn from_repr_ref(this: &Self::Repr) -> &Self
    where
        Self: Sized,
    {
        this
    }
}

/// Marker type indicating no meaningful state.
#[derive(Debug)]
pub struct Stateless(#[allow(unused)] [()]);

impl State for Stateless {
    type Repr = Infallible;
}

/// An [`Error<S>`] with its state temporarily extracted. It maintains a compatible
/// storage layout to support reattachment.
pub struct Vacant<S>
where
    S: State,
{
    inner: Option<RawVacant>,
    _marker: PhantomData<S>,
}

impl<S> Vacant<S>
where
    S: State,
{
    pub(crate) fn new(vacant: Option<RawVacant>) -> Self {
        Self {
            inner: vacant,
            _marker: PhantomData,
        }
    }

    /// Restores the original error by reattaching the extracted state.
    pub fn with_state(self, state: S) -> Error<S> {
        let Some(vacant) = self.inner else {
            return Error::from_state(state);
        };

        let err = vacant
            .try_with_state(S::into_repr(state))
            .expect("Vacant must be created with correct state storage type");

        Error(err)
    }

    /// Converts into a stateless error. Returns `None` if no error details remain.
    pub fn try_into_stateless(self) -> result::Result<Error, Self> {
        let Some(vacant) = self.inner else {
            return Err(Self::new(None));
        };

        match vacant.try_into_stateless() {
            Ok(err) => Ok(Error(err)),
            Err(err) => Err(Self::new(Some(err))),
        }
    }
}

impl<S> Debug for Vacant<S>
where
    S: State,
{
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        let Some(vacant) = &self.inner else {
            return write!(f, "Vacant");
        };
        Debug::fmt(vacant, f)
    }
}