ggemini 0.20.0

Glib/Gio-oriented network API for Gemini protocol
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

pub mod error;
pub use error::Error;

/// [Input Expected](https://geminiprotocol.net/docs/protocol-specification.gmi#status-10) status code
pub const CODE: &[u8] = b"10";

/// Default message if the optional value was not provided by the server
/// * useful to skip match cases in external applications,
///   by using `super::message_or_default` method.
pub const DEFAULT_MESSAGE: &str = "Input expected";

/// Hold header `String` for [Input Expected](https://geminiprotocol.net/docs/protocol-specification.gmi#status-10) status code
/// * this response type does not contain body data
/// * the header member is closed to require valid construction
pub struct Default(String);

impl Default {
    // Constructors

    /// Parse `Self` from buffer contains header bytes
    pub fn from_utf8(buffer: &[u8]) -> Result<Self, Error> {
        if !buffer.starts_with(CODE) {
            return Err(Error::Code);
        }
        Ok(Self(
            std::str::from_utf8(
                crate::client::connection::response::header_bytes(buffer).map_err(Error::Header)?,
            )
            .map_err(Error::Utf8Error)?
            .to_string(),
        ))
    }

    // Getters

    /// Get optional message for `Self`
    /// * return `None` if the message is empty
    pub fn message(&self) -> Option<&str> {
        self.0.get(2..).map(|s| s.trim()).filter(|x| !x.is_empty())
    }

    /// Get optional message for `Self`
    /// * if the optional message not provided by the server, return `DEFAULT_MESSAGE`
    pub fn message_or_default(&self) -> &str {
        self.message().unwrap_or(DEFAULT_MESSAGE)
    }

    /// Get header string of `Self`
    pub fn as_str(&self) -> &str {
        &self.0
    }

    /// Get header bytes of `Self`
    pub fn as_bytes(&self) -> &[u8] {
        self.0.as_bytes()
    }
}

#[test]
fn test() {
    // ok
    let d = Default::from_utf8("10 Default\r\n".as_bytes()).unwrap();
    assert_eq!(d.message(), Some("Default"));
    assert_eq!(d.message_or_default(), "Default");
    assert_eq!(d.as_str(), "10 Default\r\n");
    assert_eq!(d.as_bytes(), "10 Default\r\n".as_bytes());

    let d = Default::from_utf8("10\r\n".as_bytes()).unwrap();
    assert_eq!(d.message(), None);
    assert_eq!(d.message_or_default(), DEFAULT_MESSAGE);
    assert_eq!(d.as_str(), "10\r\n");
    assert_eq!(d.as_bytes(), "10\r\n".as_bytes());

    // err
    assert!(Default::from_utf8("13 Fail\r\n".as_bytes()).is_err());
    assert!(Default::from_utf8("Fail\r\n".as_bytes()).is_err());
    assert!(Default::from_utf8("Fail".as_bytes()).is_err());
}