knave 0.14.17

A Lisp programming language for humans and agents that infers types and ownership and compiles to readable Rust
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

use std::fmt::Display;
use std::io::{self, ErrorKind, StdoutLock, Write};

use super::exit_status::ExitStatus;
use super::standard_error::StandardError;

pub struct StandardOutput<W: Write> {
    writer: W,
}

impl StandardOutput<StdoutLock<'static>> {
    pub fn locked() -> Self {
        Self::new(io::stdout().lock())
    }
}

impl<W: Write> StandardOutput<W> {
    fn new(writer: W) -> Self {
        Self { writer }
    }

    pub fn write(mut self, answer: impl Display) -> ExitStatus {
        match self.write_and_flush(answer) {
            Err(error) if error.kind() != ErrorKind::BrokenPipe => Self::report_unwritable(&error),
            _ => ExitStatus::Success,
        }
    }

    fn write_and_flush(&mut self, answer: impl Display) -> io::Result<()> {
        write!(self.writer, "{answer}")?;
        self.writer.flush()
    }

    fn report_unwritable(error: &io::Error) -> ExitStatus {
        StandardError::write_line(format_args!("error: cannot write standard output: {error}"));
        ExitStatus::UsageError
    }
}

#[cfg(test)]
mod tests {
    use std::io::{self, ErrorKind, Write};

    use super::StandardOutput;
    use crate::cli::exit_status::ExitStatus;

    struct FailingWriter {
        kind: ErrorKind,
    }

    impl Write for FailingWriter {
        fn write(&mut self, _: &[u8]) -> io::Result<usize> {
            Err(io::Error::from(self.kind))
        }

        fn flush(&mut self) -> io::Result<()> {
            Ok(())
        }
    }

    struct UnflushableWriter;

    impl Write for UnflushableWriter {
        fn write(&mut self, written: &[u8]) -> io::Result<usize> {
            Ok(written.len())
        }

        fn flush(&mut self) -> io::Result<()> {
            Err(io::Error::from(ErrorKind::StorageFull))
        }
    }

    struct OutputFixture;

    impl OutputFixture {
        const ANSWER: &str = "(fake answer)";

        fn written() -> (ExitStatus, String) {
            let mut written = Vec::new();
            let status = StandardOutput::new(&mut written).write(Self::ANSWER);
            let text = String::from_utf8(written).expect("the answer is text");
            (status, text)
        }

        fn failing_with(kind: ErrorKind) -> ExitStatus {
            StandardOutput::new(FailingWriter { kind }).write(Self::ANSWER)
        }

        fn unflushable() -> ExitStatus {
            StandardOutput::new(UnflushableWriter).write(Self::ANSWER)
        }
    }

    #[test]
    fn writes_the_answer_and_succeeds() {
        let (status, text) = OutputFixture::written();
        assert_eq!(status, ExitStatus::Success);
        assert_eq!(text, OutputFixture::ANSWER);
    }

    #[test]
    fn treats_a_closed_reader_as_success() {
        let status = OutputFixture::failing_with(ErrorKind::BrokenPipe);
        assert_eq!(status, ExitStatus::Success);
    }

    #[test]
    fn reports_any_other_failed_write_as_a_usage_error() {
        let status = OutputFixture::failing_with(ErrorKind::StorageFull);
        assert_eq!(status, ExitStatus::UsageError);
    }

    #[test]
    fn reports_a_failed_flush_as_a_usage_error() {
        assert_eq!(OutputFixture::unflushable(), ExitStatus::UsageError);
    }
}