bibeam-core 0.0.1

Shared types, errors, and identity primitives.
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

#![forbid(unsafe_code)]
//! Top-level error type for the `BiBeam` core crate.
//!
//! [`enum@Error`] groups failures by class — config / crypto / transport /
//! protocol / storage / geoip / io — so downstream callers can match on the
//! cause without needing to know the precise sub-error type. Each variant
//! carries a human-readable string except [`Error::Io`], which re-wraps
//! [`std::io::Error`] losslessly via `#[from]`.

use thiserror::Error;

/// Class-tagged error type for the core crate.
///
/// Higher layers convert their own error types into one of these classes
/// (typically `Crypto`, `Protocol`, or `Transport`) so the surface presented
/// to applications stays compact.
#[derive(Debug, Error)]
pub enum Error {
    /// Configuration could not be loaded, validated, or applied.
    #[error("config error: {0}")]
    Config(String),
    /// A cryptographic primitive or handshake failed.
    #[error("crypto error: {0}")]
    Crypto(String),
    /// A transport-layer failure (WireGuard/UDP, TCP).
    #[error("transport error: {0}")]
    Transport(String),
    /// A protocol-layer violation or unexpected message.
    #[error("protocol error: {0}")]
    Protocol(String),
    /// Persistent storage failed (read, write, schema, etc.).
    #[error("storage error: {0}")]
    Storage(String),
    /// `GeoIP` DB open / parse / lookup failed (R-REGION.2 / D-5).
    ///
    /// Surfaces failures from the operator-supplied
    /// `GeoLite2-Country` `.mmdb` file — both file-open / I/O errors
    /// and structural (`InvalidDatabase` / `Decoding`) errors fold
    /// into the same `String` form so downstream callers can match
    /// on the variant without depending on the upstream `maxminddb`
    /// crate. Per D-5, the cross-check is warn-only at MVP —
    /// callers convert this error class into an audit-log entry
    /// rather than refusing admission.
    #[error("geoip error: {0}")]
    Geoip(String),
    /// An underlying [`std::io::Error`] propagated unchanged.
    #[error("io error: {0}")]
    Io(#[from] std::io::Error),
}