rustun 0.5.0

A library for implementing STUN server and client asynchronously
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use fibers::sync::oneshot::MonitorError;
use std::io;
use std::sync::mpsc::SendError;
use stun_codec::rfc5389::attributes::ErrorCode;
use stun_codec::AttributeType;
use trackable::error::{self, ErrorKindExt, TrackableError};

/// This crate specific `Error` type.
#[derive(Debug, Clone, TrackableError)]
pub struct Error(TrackableError<ErrorKind>);
impl From<MonitorError<Error>> for Error {
    fn from(f: MonitorError<Error>) -> Self {
        f.unwrap_or_else(|| {
            ErrorKind::Other
                .cause("Monitor channel has disconnected")
                .into()
        })
    }
}
impl From<io::Error> for Error {
    fn from(f: io::Error) -> Self {
        ErrorKind::Other.cause(f).into()
    }
}
impl<T> From<SendError<T>> for Error {
    fn from(_: SendError<T>) -> Self {
        ErrorKind::Other.cause("Receiver has terminated").into()
    }
}
impl From<bytecodec::Error> for Error {
    fn from(f: bytecodec::Error) -> Self {
        let original_error_kind = *f.kind();
        let kind = match original_error_kind {
            bytecodec::ErrorKind::InvalidInput => ErrorKind::InvalidInput,
            _ => ErrorKind::Other,
        };
        track!(kind.takes_over(f); original_error_kind).into()
    }
}
impl From<MessageError> for Error {
    fn from(f: MessageError) -> Self {
        ErrorKind::InvalidMessage(f.kind().clone())
            .takes_over(f)
            .into()
    }
}
impl From<ErrorCode> for Error {
    fn from(f: ErrorCode) -> Self {
        ErrorKind::Other
            .cause(format!("STUN error response: {f:?}"))
            .into()
    }
}
impl From<fibers_transport::Error> for Error {
    fn from(f: fibers_transport::Error) -> Self {
        let original_error_kind = *f.kind();
        let kind = match original_error_kind {
            fibers_transport::ErrorKind::InvalidInput => ErrorKind::InvalidInput,
            _ => ErrorKind::Other,
        };
        track!(kind.takes_over(f); original_error_kind).into()
    }
}

/// Possible error kinds.
#[derive(Debug, Clone)]
pub enum ErrorKind {
    /// Input is invalid.
    InvalidInput,

    /// A message is invalid.
    ///
    /// This error does not affect the overall execution of a channel/client/server.
    InvalidMessage(MessageErrorKind),

    /// Other errors.
    Other,
}
impl error::ErrorKind for ErrorKind {}

/// Message level error.
#[derive(Debug, Clone, TrackableError)]
#[trackable(error_kind = "MessageErrorKind")]
pub struct MessageError(TrackableError<MessageErrorKind>);
impl From<MonitorError<MessageError>> for MessageError {
    fn from(f: MonitorError<MessageError>) -> Self {
        f.unwrap_or_else(|| {
            MessageErrorKind::Other
                .cause("`Channel` instance has dropped")
                .into()
        })
    }
}
impl From<Error> for MessageError {
    fn from(f: Error) -> Self {
        let original_error_kind = f.kind().clone();
        track!(MessageErrorKind::Other.takes_over(f); original_error_kind).into()
    }
}
impl From<fibers_transport::Error> for MessageError {
    fn from(f: fibers_transport::Error) -> Self {
        let original_error_kind = *f.kind();
        let kind = match original_error_kind {
            fibers_transport::ErrorKind::InvalidInput => MessageErrorKind::InvalidInput,
            _ => MessageErrorKind::Other,
        };
        track!(kind.takes_over(f); original_error_kind).into()
    }
}

/// Possible error kinds.
#[derive(Debug, Clone)]
pub enum MessageErrorKind {
    /// Unexpected response message.
    UnexpectedResponse,

    /// There are some malformed attributes in a message.
    MalformedAttribute,

    /// There are unknown comprehension-required attributes.
    ///
    /// If a server receives a message that contains unknown comprehension-required attributes,
    /// it should reply an `ErrorResponse` message that has the [`UnknownAttribute`] error code and
    /// an [`UnknownAttributes`] attribute.
    ///
    /// [`UnknownAttribute`]: https://docs.rs/stun_codec/0.1/stun_codec/rfc5389/errors/struct.UnknownAttribute.html
    /// [`UnknownAttributes`]: https://docs.rs/stun_codec/0.1/stun_codec/rfc5389/attributes/struct.UnknownAttributes.html
    UnknownAttributes(Vec<AttributeType>),

    /// Input is invalid.
    InvalidInput,

    /// Operation timed out.
    Timeout,

    /// Other errors.
    Other,
}
impl error::ErrorKind for MessageErrorKind {}