brokaw 0.2.0

📰 An NNTP client liberary. More at 11! 📰
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

use std::str::Utf8Error;

use crate::types::prelude::*;

/// All of the ways that a failure can occur within Brokaw
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// This error indicates an application layer failure.
    ///
    /// For example, asking for a non-existent group will return
    /// [`NoSuchNewsGroup`](`crate::types::prelude::Kind::NoSuchNewsgroup`) (code 411),
    /// which is not a protocol error.
    #[error("Server returned {code:?} -- {msg:?}")]
    Failure {
        /// The response code
        code: ResponseCode,
        /// The raw response
        resp: RawResponse,
        /// An error message associated with the response
        msg: Option<String>,
    },
    #[error(transparent)]
    /// An error raised by the underlying connection
    ///
    /// This is usually of an I/O error or a TLS error
    Connection(#[from] crate::raw::error::Error),
    /// An error deserializing a [RawResponse] into a concrete type
    #[error("{0}")]
    Deserialization(String),
    /// An error deserializing bytes as UTF-8
    #[error("{0}")]
    Utf8(#[from] Utf8Error),
}

impl Error {
    pub(crate) fn failure(resp: RawResponse) -> Self {
        Error::Failure {
            code: resp.code(),
            resp,
            msg: None,
        }
    }

    pub(crate) fn de(msg: impl AsRef<str>) -> Self {
        Error::Deserialization(msg.as_ref().to_string())
    }

    pub(crate) fn missing_field(name: impl AsRef<str>) -> Self {
        Error::Deserialization(format!("Missing field `{}`", name.as_ref()))
    }

    pub(crate) fn parse_error(name: impl AsRef<str>) -> Self {
        Error::Deserialization(format!("Could not parse field `{}`", name.as_ref()))
    }

    pub(crate) fn missing_data_blocks() -> Self {
        Error::Deserialization("Response is missing multi-line data blocks".to_string())
    }

    pub(crate) fn invalid_data_blocks(msg: impl AsRef<str>) -> Self {
        Error::Deserialization(format!("Invalid data-block section -- {}", msg.as_ref()))
    }
}

/// A result type returned by the library
pub type Result<T> = std::result::Result<T, Error>;