cccc-sdk 0.0.1

Official Rust client SDK for CCCC daemon IPC v1
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

use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::fmt;

/// Structured application error returned by the CCCC daemon.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct DaemonError {
    pub code: String,
    pub message: String,
    #[serde(default)]
    pub details: Value,
}

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

impl std::error::Error for DaemonError {}

/// Errors produced while discovering, connecting to, or calling CCCC.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    #[error("CCCC daemon endpoint was not found: {0}")]
    EndpointNotFound(String),

    #[error("invalid CCCC daemon endpoint descriptor: {0}")]
    InvalidEndpoint(String),

    #[error("Unix sockets are unavailable on this platform")]
    UnixSocketUnsupported,

    #[error("CCCC daemon I/O failed: {0}")]
    Io(#[from] std::io::Error),

    #[error("CCCC daemon returned invalid JSON: {0}")]
    Json(#[from] serde_json::Error),

    #[error("CCCC daemon response exceeded {0} bytes")]
    ResponseTooLarge(usize),

    #[error("CCCC daemon request exceeded {0} bytes")]
    RequestTooLarge(usize),

    #[error("CCCC daemon closed the connection without a response")]
    EmptyResponse,

    #[error("CCCC daemon response used unsupported IPC version {0}")]
    UnsupportedIpcVersion(u32),

    #[error("CCCC daemon error {0}")]
    Daemon(#[from] DaemonError),

    #[error("incompatible CCCC daemon: {0}")]
    Incompatible(String),
}

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