nullnet_libdatastore/
lib.rs

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
mod client;
mod config;

#[rustfmt::skip]
#[allow(clippy::pedantic)]
mod datastore;

use core::fmt;

pub use client::DatastoreClient;
pub use config::DatastoreConfig;
pub use datastore::{
    AdvanceFilter, AggregateBody, AggregateRequest, Aggregation, BatchCreateBody,
    BatchCreateRequest, CreateParams, CreateRequest, DeleteRequest, EntityFieldFrom, EntityFieldTo,
    FieldRelation, GetByFilterBody, GetByFilterRequest, GetByIdRequest, Join, LoginBody, LoginData,
    LoginRequest, LoginResponse, MultipleSort, Order, Params, Query, Response, UpdateRequest,
    Value,
};

/// Represents the different kinds of errors that can occur during configuration monitoring.
#[derive(Debug)]
pub enum ErrorKind {
    ErrorCouldNotConnectToDatastore,
    ErrorRequestFailed,
    ErrorBadToken,
}

/// A structured error type for `libconfmon`.
///
/// # Fields
/// - `kind`: The specific type of error.
/// - `message`: A detailed message explaining the error.
#[derive(Debug)]
pub struct Error {
    pub kind: ErrorKind,
    pub message: String,
}

impl fmt::Display for Error {
    /// Formats the error for user-friendly display.
    ///
    /// The format includes the error kind and the message, for example:
    ///
    /// `[ErrorCouldNotConnectToDatastore] Connection timed out`.
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "[{:?}] {}", self.kind, self.message)
    }
}