wasmi 1.0.9

WebAssembly interpreter
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

use core::{any::type_name, fmt};

#[cfg(doc)]
use super::{PrunedStore, Store, StoreInner};

/// An error occurred on [`Store<T>`] or [`StoreInner`] methods.
#[derive(Debug, Copy, Clone)]
pub enum StoreError<E> {
    /// An error representing an internal error, a.k.a. a bug or invalid behavior within Wasmi.
    Internal(InternalStoreError),
    /// An external error forwarded by the [`Store`] or [`StoreInner`].
    External(E),
}

impl<E: fmt::Display> fmt::Display for StoreError<E> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            StoreError::Internal(error) => fmt::Display::fmt(error, f),
            StoreError::External(error) => fmt::Display::fmt(error, f),
        }
    }
}

/// A [`Store`] or [`StoreInner`] internal error, a.k.a. bug or invalid behavior within Wasmi.
#[derive(Debug, Copy, Clone)]
pub struct InternalStoreError {
    kind: InternalStoreErrorKind,
}

impl InternalStoreError {
    /// Creates a new [`InternalStoreError`].
    fn new(kind: InternalStoreErrorKind) -> Self {
        Self { kind }
    }

    /// An error indicating that a [`Store`] resource could not be found.
    #[cold]
    #[inline]
    pub fn not_found() -> Self {
        Self::new(InternalStoreErrorKind::EntityNotFound)
    }

    /// An error indicating that a [`Store`] resource does not originate from the store.
    #[cold]
    #[inline]
    pub fn store_mismatch() -> Self {
        Self::new(InternalStoreErrorKind::StoreMismatch)
    }

    /// An error indicating that restoring a [`PrunedStore`] to a [`Store<T>`] mismatched `T`.
    #[cold]
    #[inline]
    pub fn restore_type_mismatch<T>() -> Self {
        Self::new(InternalStoreErrorKind::RestoreTypeMismatch(
            RestoreTypeMismatchError::new::<T>(),
        ))
    }
}

impl fmt::Display for InternalStoreError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let message = match &self.kind {
            InternalStoreErrorKind::RestoreTypeMismatch(error) => {
                return fmt::Display::fmt(error, f)
            }
            InternalStoreErrorKind::StoreMismatch => "store owner mismatch",
            InternalStoreErrorKind::EntityNotFound => "entity not found",
        };
        write!(f, "failed to resolve entity: {message}")
    }
}

#[derive(Debug, Copy, Clone)]
enum InternalStoreErrorKind {
    /// An error when restoring a [`PrunedStore`] with an incorrect `T` for [`Store<T>`].
    RestoreTypeMismatch(RestoreTypeMismatchError),
    /// An error indicating that a store resource does not originate from the given store.
    StoreMismatch,
    /// An error indicating that a store resource was not found.
    EntityNotFound,
}

impl<E> StoreError<E> {
    /// Create a new [`StoreError`] from the external `error`.
    pub fn external(error: E) -> Self {
        Self::External(error)
    }
}

impl<E> From<InternalStoreError> for StoreError<E> {
    fn from(error: InternalStoreError) -> Self {
        Self::Internal(error)
    }
}

/// Error occurred when restoring a [`PrunedStore`] to a [`Store<T>`] with an mismatching `T`.
#[derive(Debug, Copy, Clone)]
struct RestoreTypeMismatchError {
    type_name: fn() -> &'static str,
}

impl RestoreTypeMismatchError {
    /// Create a new [`RestoreTypeMismatchError`].
    pub fn new<T>() -> Self {
        Self {
            type_name: type_name::<T>,
        }
    }
}

impl fmt::Display for RestoreTypeMismatchError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "failed to unprune store due to type mismatch: {}",
            (self.type_name)()
        )
    }
}