rns-hooks 0.1.4

WASM hook system for the Reticulum Network Stack
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

use std::fmt;

/// Errors that can occur in the hook system.
#[derive(Debug)]
pub enum HookError {
    /// WASM module failed to compile.
    CompileError(String),
    /// WASM module failed to instantiate.
    InstantiationError(String),
    /// WASM execution ran out of fuel.
    FuelExhausted,
    /// WASM execution trapped (panic, out-of-bounds, etc.).
    Trap(String),
    /// Hook returned invalid result data.
    InvalidResult(String),
    /// Hook was auto-disabled after too many consecutive failures.
    AutoDisabled {
        name: String,
        consecutive_traps: u32,
    },
    /// Hook point not found or invalid.
    InvalidHookPoint(String),
    /// I/O error loading a WASM module.
    IoError(std::io::Error),
    /// WASM module was compiled against an incompatible ABI version.
    AbiVersionMismatch {
        hook_name: String,
        expected: i32,
        found: Option<i32>,
    },
}

impl fmt::Display for HookError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            HookError::CompileError(msg) => write!(f, "compile error: {}", msg),
            HookError::InstantiationError(msg) => write!(f, "instantiation error: {}", msg),
            HookError::FuelExhausted => write!(f, "fuel exhausted"),
            HookError::Trap(msg) => write!(f, "trap: {}", msg),
            HookError::InvalidResult(msg) => write!(f, "invalid result: {}", msg),
            HookError::AutoDisabled {
                name,
                consecutive_traps,
            } => {
                write!(
                    f,
                    "hook '{}' auto-disabled after {} consecutive traps",
                    name, consecutive_traps
                )
            }
            HookError::InvalidHookPoint(msg) => write!(f, "invalid hook point: {}", msg),
            HookError::IoError(e) => write!(f, "I/O error: {}", e),
            HookError::AbiVersionMismatch {
                hook_name,
                expected,
                found,
            } => match found {
                Some(v) => write!(
                    f,
                    "hook '{}' ABI version mismatch: host expects {}, hook has {}. \
                         Recompile the hook against the current rns-hooks-sdk.",
                    hook_name, expected, v
                ),
                None => write!(
                    f,
                    "hook '{}' missing __rns_abi_version export (expected ABI version {}). \
                         Recompile the hook against the current rns-hooks-sdk.",
                    hook_name, expected
                ),
            },
        }
    }
}

impl std::error::Error for HookError {}

impl From<std::io::Error> for HookError {
    fn from(e: std::io::Error) -> Self {
        HookError::IoError(e)
    }
}