iicp-client 0.2.0

Official Rust client SDK for the IICP protocol (ADR-016)
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

// SPDX-License-Identifier: Apache-2.0
use thiserror::Error;

/// All errors emitted by the IICP client SDK.
#[derive(Debug, Error)]
pub enum IicpError {
    /// Network or HTTP transport failure.
    #[error("network error: {0}")]
    Http(#[from] reqwest::Error),

    /// Directory or node returned an IICP error response.
    #[error("[{code}] {message} (HTTP {status})")]
    Protocol {
        code: String,
        message: String,
        status: u16,
    },

    /// SDK-03: intent URN does not match the required pattern.
    #[error("SDK-03: invalid intent URN: {0}")]
    InvalidIntent(String),

    /// SDK-04: timeout_ms exceeds the maximum of 120 000 ms.
    #[error("SDK-04: timeout_ms must be ≤ 120000; got {0}")]
    TimeoutTooLarge(u64),

    /// Discover returned an empty node list.
    #[error("no nodes available for intent {intent}")]
    NoNodes { intent: String },

    /// JSON serialization / deserialization failure.
    #[error("serialization error: {0}")]
    Serde(#[from] serde_json::Error),

    /// Node registration, heartbeat, or server bind failure.
    #[error("node error: {0}")]
    Node(String),
}

impl IicpError {
    /// True for errors where retrying a different attempt may succeed (SDK-05).
    pub fn is_transient(&self) -> bool {
        matches!(
            self,
            IicpError::Protocol {
                status: 429 | 502 | 503 | 504,
                ..
            } | IicpError::Http(_)
        )
    }
}

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