asterisk-rs-core 0.6.0

Shared types, error framework, and event bus for asterisk-rs
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

//! Base error types for the asterisk-rs ecosystem.

/// top-level error type encompassing all asterisk-rs failures
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    #[error("connection failed: {0}")]
    Connection(#[from] ConnectionError),

    #[error("authentication failed: {0}")]
    Auth(#[from] AuthError),

    #[error("operation timed out: {0}")]
    Timeout(#[from] TimeoutError),

    #[error("protocol error: {0}")]
    Protocol(#[from] ProtocolError),

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

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

#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum ConnectionError {
    #[error("failed to connect to {address}: {source}")]
    ConnectFailed {
        address: String,
        source: std::io::Error,
    },

    #[error("connection closed unexpectedly")]
    Closed,

    #[error("TLS handshake failed: {0}")]
    Tls(String),

    #[error("DNS resolution failed for {host}: {source}")]
    DnsResolution {
        host: String,
        source: std::io::Error,
    },
}

#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum AuthError {
    #[error("login rejected: {reason}")]
    Rejected { reason: String },

    #[error("invalid credentials")]
    InvalidCredentials,

    #[error("challenge-response failed")]
    ChallengeFailed,
}

#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum TimeoutError {
    #[error("action timed out after {elapsed:?}")]
    Action { elapsed: std::time::Duration },

    #[error("connection timed out after {elapsed:?}")]
    Connection { elapsed: std::time::Duration },
}

#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum ProtocolError {
    #[error("malformed message: {details}")]
    MalformedMessage { details: String },

    #[error("unexpected response: expected {expected}, got {actual}")]
    UnexpectedResponse { expected: String, actual: String },

    #[error("unsupported protocol version: {version}")]
    UnsupportedVersion { version: String },
}