ferroid-tonic-core 2.0.0

Shared types for the core gRPC protocol and shared types
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

//! Error types for the ID generation service.
//!
//! This module defines the central `Error` enum, which captures all recoverable
//! and reportable error cases within the ID generation system. It implements
//! `From<Error>` for `tonic::Status` to enable seamless gRPC error propagation
//! to clients with appropriate status codes and messages.
//!
//! ## Error Cases
//! - `ChannelError`: An internal communication failure between tasks or
//!   workers.
//! - `IdGeneration`: An error occurred during ID creation (via the `ferroid`
//!   generator).
//! - `RequestCancelled`: The client canceled the request mid-flight.
//! - `InvalidRequest`: The client request was malformed or exceeded bounds.
//! - `ServiceShutdown`: A request arrived while the service was shutting down.

use tonic::Status;

pub type Result<T> = core::result::Result<T, Error>;

/// Unified error type for the ID generation service.
#[derive(Clone, thiserror::Error, Debug)]
#[non_exhaustive]
pub enum Error {
    /// Internal channel send/receive failure (e.g., closed or full channel).
    #[error("Channel error: {context}")]
    ChannelError { context: String },

    /// Underlying Snowflake ID generation failed. This is currently infallible,
    /// but kept as a placeholder if the generator type yields an error.
    #[error("ID error: {0:?}")]
    IdGeneration(#[from] core::convert::Infallible),

    /// The client aborted the request.
    #[error("Request cancelled by client")]
    RequestCancelled,

    /// The client request was invalid or exceeded constraints.
    #[error("Invalid request: {reason}")]
    InvalidRequest { reason: String },

    /// The service is in the process of shutting down.
    #[error("Service is shutting down")]
    ServiceShutdown,
}

impl From<Error> for Status {
    fn from(err: Error) -> Self {
        match err {
            Error::ChannelError { context } => Self::internal(format!("Channel error: {context}")),
            Error::IdGeneration(e) => Self::internal(format!("ID generation error: {e:?}")),
            Error::RequestCancelled => Self::cancelled("Request was cancelled"),
            Error::InvalidRequest { reason } => Self::invalid_argument(reason),
            Error::ServiceShutdown => Self::unavailable("Service is shutting down"),
        }
    }
}