convey 0.2.0

A Rust create for outputting information and log messages for humans and machines
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

use crate::{human, json, Error, Render};

/// Render some text
pub fn text<T: AsRef<str>>(input: T) -> Text {
    Text(input.as_ref().to_string())
}

/// Render a newline
///
/// This is just a shorthand for calling `text`.
pub fn newline() -> Text {
    text("\n")
}

#[derive(Clone, serde_derive::Serialize)]
pub struct Text(String);

impl Render for Text {
    fn render_for_humans(&self, fmt: &mut human::Formatter) -> Result<(), Error> {
        fmt.write(self.0.as_bytes())?;
        Ok(())
    }

    fn render_json(&self, fmt: &mut json::Formatter) -> Result<(), Error> {
        fmt.write(self)?;
        Ok(())
    }
}

#[cfg(test)]
mod test {
    use super::text;
    use crate::{human, json, Render};
    use proptest::{prop_assert, prop_assert_eq, proptest, proptest_helper};

    proptest! {
        #[test]
        fn renders_text_exactly(s in "\\PC") {
            let item = text(&s);

            let human_output = human::test();
            item.render_for_humans(&mut human_output.formatter()).unwrap();
            prop_assert_eq!(&human_output.to_string(), &s);

            let json = json::test();
            item.render_json(&mut json.formatter()).unwrap();
            prop_assert_eq!(json.to_string(), serde_json::json!(s).to_string());
        }
    }
}