linkrs-core 0.1.0

Core data structures, types, and errors for Linkrs
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

//! Manager Error Type
//!
//! Errors related to the Manager layer components, including the Schema Manager, Index Manager, and Storage Client.

use thiserror::Error;

use crate::error::codes::{ErrorCode, PublicError, ToPublicError};

/// Manager operation result type
pub type ManagerResult<T> = Result<T, ManagerError>;

/// Incorrect classification of the error
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ErrorCategory {
    /// retryable error
    Retryable,
    /// An error that cannot be retried.
    NonRetryable,
}

/// Manager Error Type
#[derive(Error, Debug, Clone, PartialEq)]
pub enum ManagerError {
    #[error("Resource not found: {0}")]
    NotFound(String),

    #[error("Resource already exists: {0}")]
    AlreadyExists(String),

    #[error("Invalid input: {0}")]
    InvalidInput(String),

    #[error("Storage error: {0}")]
    StorageError(String),

    #[error("Schema error: {0}")]
    SchemaError(String),

    #[error("Transaction error: {0}")]
    TransactionError(String),

    #[error("Timeout error: {0}")]
    TimeoutError(String),

    #[error("Other error: {0}")]
    Other(String),
}

impl ManagerError {
    /// Obtaining the error classification
    pub fn category(&self) -> ErrorCategory {
        match self {
            ManagerError::StorageError(_) | ManagerError::TimeoutError(_) => {
                ErrorCategory::Retryable
            }
            _ => ErrorCategory::NonRetryable,
        }
    }

    /// Checking for retryability
    pub fn is_retryable(&self) -> bool {
        matches!(self.category(), ErrorCategory::Retryable)
    }

    /// The error “Create not found” was not encountered during the process.
    pub fn not_found(msg: impl Into<String>) -> Self {
        Self::NotFound(msg.into())
    }

    /// Create Existing Error
    pub fn already_exists(msg: impl Into<String>) -> Self {
        Self::AlreadyExists(msg.into())
    }

    /// An error was generated due to invalid input.
    pub fn invalid_input(msg: impl Into<String>) -> Self {
        Self::InvalidInput(msg.into())
    }

    /// Creating Storage Errors
    pub fn storage_error(msg: impl Into<String>) -> Self {
        Self::StorageError(msg.into())
    }

    /// An error occurred while creating the schema.
    pub fn schema_error(msg: impl Into<String>) -> Self {
        Self::SchemaError(msg.into())
    }

    /// Create Transaction Error
    pub fn transaction_error(msg: impl Into<String>) -> Self {
        Self::TransactionError(msg.into())
    }

    /// An error occurred due to a timeout.
    pub fn timeout_error(msg: impl Into<String>) -> Self {
        Self::TimeoutError(msg.into())
    }
}

impl ToPublicError for ManagerError {
    fn to_public_error(&self) -> PublicError {
        PublicError::new(self.to_error_code(), self.to_public_message())
    }

    fn to_error_code(&self) -> ErrorCode {
        match self {
            ManagerError::NotFound(_) => ErrorCode::ResourceNotFound,
            ManagerError::AlreadyExists(_) => ErrorCode::ResourceAlreadyExists,
            ManagerError::InvalidInput(_) => ErrorCode::InvalidInput,
            ManagerError::TimeoutError(_) => ErrorCode::Timeout,
            _ => ErrorCode::InternalError,
        }
    }

    fn to_public_message(&self) -> String {
        self.to_string()
    }
}