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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
use core::any::Any;
use core::fmt::{self, Debug};

use crate::input::Input;

use super::FromContext;

#[cfg(feature = "full-context")]
use alloc::{boxed::Box, vec::Vec};

/// The base context surrounding an error.
pub trait Context: Any + Debug {
    /// The operation that was attempted when an error occurred.
    ///
    /// It should described in a simple manner what is trying to be achieved and
    /// make sense in the following sentence if you were to substitute it:
    ///
    /// ```text
    /// error attempting to <operation>.
    /// ```
    fn operation(&self) -> &'static str;

    /// Returns a [`fmt::Display`] formattable value of what was expected.
    fn expected(&self) -> Option<&dyn fmt::Display>;

    /// Return a reference of self as [`Any`].
    // FIXME: An ideal implementation wouldn't require this function and we
    // would just lean on the super trait requirement, but doesn't seem possible
    // today with trait objects.
    //
    // See: https://github.com/rust-lang/rfcs/issues/2035
    fn as_any(&self) -> &dyn Any;
}

/// A walkable stack of [`Context`]s collected from an error.
pub trait ContextStack: 'static {
    /// The root context.
    fn root(&self) -> ExpectedContext;

    /// Return the total number of contexts.
    fn count(&self) -> usize;

    /// Walk the context stack, starting with the highest context to the root.
    ///
    /// Returns `true` if all of the stack available was walked, `false` if not.
    fn walk<'a>(&'a self, f: &mut ContextStackWalker<'a>) -> bool;
}

/// A [`ContextStack`] builder.
pub trait ContextStackBuilder {
    /// Create the builder from a root expected context.
    fn from_root(context: ExpectedContext) -> Self;

    /// Push an additional context onto the stack.
    fn push<C>(&mut self, context: C)
    where
        C: Context;
}

/// A dynamic function for walking a context stack.
///
/// Returns `true` if the walk should continue, `false` if not.
///
/// # Parameters
///
/// - `index` (the index of the context starting from `1`).
/// - `context` (the context at the provided index).
pub type ContextStackWalker<'a> = dyn FnMut(usize, &dyn Context) -> bool + 'a;

///////////////////////////////////////////////////////////////////////////////
// Basic expected context

impl Context for &'static str {
    fn operation(&self) -> &'static str {
        "read"
    }

    fn expected(&self) -> Option<&dyn fmt::Display> {
        Some(self)
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

///////////////////////////////////////////////////////////////////////////////
// Expected context

/// A sealed expected [`Context`].
#[derive(Clone, Copy, Debug)]
pub struct ExpectedContext {
    pub(crate) operation: &'static str,
    pub(crate) expected: &'static str,
}

impl Context for ExpectedContext {
    fn operation(&self) -> &'static str {
        self.operation
    }

    fn expected(&self) -> Option<&dyn fmt::Display> {
        Some(&self.expected)
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

///////////////////////////////////////////////////////////////////////////////
// Operation context

#[derive(Clone, Copy, Debug)]
pub(crate) struct OperationContext(pub(crate) &'static str);

impl Context for OperationContext {
    fn operation(&self) -> &'static str {
        self.0
    }

    fn expected(&self) -> Option<&dyn fmt::Display> {
        None
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

///////////////////////////////////////////////////////////////////////////////
// Root context stack

/// A [`ContextStack`] that only contains the root [`ExpectedContext`].
pub struct RootContextStack {
    context: ExpectedContext,
}

impl ContextStackBuilder for RootContextStack {
    fn from_root(context: ExpectedContext) -> Self {
        Self { context }
    }

    fn push<C>(&mut self, _context: C)
    where
        C: Context,
    {
    }
}

impl ContextStack for RootContextStack {
    fn root(&self) -> ExpectedContext {
        self.context
    }

    fn count(&self) -> usize {
        1
    }

    fn walk<'a>(&'a self, f: &mut ContextStackWalker<'a>) -> bool {
        f(1, &self.context)
    }
}

///////////////////////////////////////////////////////////////////////////////
// Full context stack

/// A [`ContextStack`] that contains all [`Context`]s collected.
#[cfg(feature = "full-context")]
#[cfg_attr(docsrs, doc(cfg(feature = "full-context")))]
pub struct FullContextStack {
    root: ExpectedContext,
    stack: Vec<Box<dyn Context>>,
}

#[cfg(feature = "full-context")]
impl ContextStackBuilder for FullContextStack {
    fn from_root(context: ExpectedContext) -> Self {
        Self {
            root: context,
            stack: Vec::with_capacity(32),
        }
    }

    fn push<C>(&mut self, context: C)
    where
        C: Context,
    {
        self.stack.push(Box::new(context))
    }
}

#[cfg(feature = "full-context")]
impl ContextStack for FullContextStack {
    fn root(&self) -> ExpectedContext {
        self.root
    }

    fn count(&self) -> usize {
        self.stack.len() + 1
    }

    fn walk<'a>(&'a self, f: &mut ContextStackWalker<'a>) -> bool {
        let mut i = 1;
        for item in self.stack.iter().rev() {
            if !f(i, item.as_ref()) {
                return false;
            }
            i += 1;
        }
        f(i, &self.root)
    }
}

///////////////////////////////////////////////////////////////////////////////

#[inline(always)]
pub(crate) fn with_context<'i, F, C, T, E>(input: &'i Input, context: C, f: F) -> Result<T, E>
where
    F: FnOnce() -> Result<T, E>,
    E: FromContext<'i>,
    C: Context,
{
    f().map_err(|err| err.from_context(input, context))
}