syncbat 0.8.0

Sync-first runtime layer for batpak-family operation kits.
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

//! Synchronous byte-oriented handler contracts.

use std::{error::Error, fmt};

use crate::core::Ctx;

/// Result type returned by syncbat handlers.
pub type HandlerResult = Result<Vec<u8>, HandlerError>;

/// Function-pointer handler emitted by operation declaration macros.
pub type HandlerFn = for<'a> fn(&[u8], &mut Ctx<'a>) -> HandlerResult;

/// Error returned when a handler cannot produce output bytes.
///
/// `#[non_exhaustive]` so we can introduce post-0.8.0 variants (e.g.
/// `RateLimited`, `Unauthorized`, `Conflict`) without breaking
/// downstream exhaustive matches.
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum HandlerError {
    /// Input bytes could not be decoded or validated by the handler.
    InvalidInput(String),
    /// The handler failed while executing the operation.
    Failed(String),
}

impl HandlerError {
    /// Construct an invalid-input handler error.
    #[must_use]
    pub fn invalid_input(message: impl Into<String>) -> Self {
        Self::InvalidInput(message.into())
    }

    /// Construct an execution-failure handler error.
    #[must_use]
    pub fn failed(message: impl Into<String>) -> Self {
        Self::Failed(message.into())
    }

    /// Return a stable string code for the error class.
    #[must_use]
    pub const fn class(&self) -> &'static str {
        match self {
            Self::InvalidInput(_) => "invalid_input",
            Self::Failed(_) => "failed",
        }
    }

    /// Return the handler-provided error message.
    #[must_use]
    pub fn message(&self) -> &str {
        match self {
            Self::InvalidInput(message) | Self::Failed(message) => message,
        }
    }
}

impl fmt::Display for HandlerError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}: {}", self.class(), self.message())
    }
}

impl Error for HandlerError {}

/// Synchronous handler contract for byte-oriented operations.
pub trait Handler {
    /// Handle input bytes with mutable runtime context and return output bytes.
    ///
    /// # Errors
    /// Returns [`HandlerError`] when input decoding, validation, or operation
    /// execution fails.
    fn handle(&mut self, input: &[u8], cx: &mut Ctx<'_>) -> HandlerResult;
}

impl<F> Handler for F
where
    F: for<'a> FnMut(&[u8], &mut Ctx<'a>) -> HandlerResult,
{
    fn handle(&mut self, input: &[u8], cx: &mut Ctx<'_>) -> HandlerResult {
        self(input, cx)
    }
}