trotter 0.4.0

Trotter 🎠 is an experimental crate that aims to make writing Gemini clients fun and easy.
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

use std::{fs::File, io::Write, path::PathBuf};

use openssl::x509::X509;

use crate::error::ResponseErr;

/// A gemini response.
#[derive(Debug)]
pub struct Response {
    pub status:      u8,
    pub meta:        String,
    pub content:     Vec<u8>,
    /// The certificate of the responding server.
    pub certificate: X509,
}

type Result<T> = std::result::Result<T, ResponseErr>;

impl Response {
    /// Returns true if the response is gemtext.
    pub fn is_gemtext(&self) -> bool {
        if let Some(pos) = self.meta.find("text/gemini") {
            if pos == 0 {
                return true;
            }
        }
        false
    }

    /// Return gemtext (if any) inside this response.
    pub fn gemtext(&self) -> Result<String> {
        self.require_status(20)?;

        if self.is_gemtext() {
            return Ok(self.text()?);
        }

        Err(ResponseErr::UnexpectedFiletype(
            "text/gemini".to_string(),
            self.meta.clone(),
        ))
    }

    /// Return utf8 text (if any) inside this response, regardless of mimetype.
    pub fn text(&self) -> Result<String> {
        self.require_status(20)?;
        Ok(std::str::from_utf8(&self.content)
            .map_err(|e| ResponseErr::Utf8Content(e))?
            .to_string())
    }

    /// Save response to file.
    pub fn save(&self, file: &mut File) -> Result<()> {
        self.require_status(20)?;
        file.write_all(&self.content)
            .map_err(|e| ResponseErr::FileWrite(e))?;
        Ok(())
    }

    /// Save response to path.
    pub fn save_to_path(&self, path: impl Into<PathBuf>) -> Result<()> {
        self.require_status(20)?;

        let path = path.into();
        let mut file = File::create(path).map_err(|e| ResponseErr::FileCreate(e))?;
        file.write_all(&self.content)
            .map_err(|e| ResponseErr::FileWrite(e))?;
        Ok(())
    }

    /// Return the server's certificate pem
    pub fn certificate_pem(&self) -> Result<String> {
        Ok(std::str::from_utf8(
            &self
                .certificate
                .to_pem()
                .map_err(|e| ResponseErr::SerializingToPem(e))?,
        )
        .map_err(|e| ResponseErr::PemInvalidUtf8(e))?
        .to_string())
    }

    /// Returns a human-readable string displaying info about the
    /// server's certificate.
    ///
    /// *primarily for debugging purposes*
    pub fn certificate_info(&self) -> Result<String> {
        Ok(std::str::from_utf8(
            &self
                .certificate
                .to_text()
                .map_err(|e| ResponseErr::FailedToInspectCert(e))?,
        )
        .map_err(|e| ResponseErr::CertInfoIsntValidUtf8(e))?
        .to_string())
    }

    /// (private) Error if `s` doesn't match the status
    fn require_status(&self, s: u8) -> Result<()> {
        if self.status != s {
            Err(ResponseErr::UnexpectedStatus(
                s.into(),
                self.status.into(),
                self.meta.clone(),
            ))
        } else {
            Ok(())
        }
    }
}