retina 0.4.19

high-level RTSP multimedia streaming library
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

// Copyright (C) The Retina Authors
// SPDX-License-Identifier: MIT OR Apache-2.0

//! Formatter for byte data that is expected to be mostly ASCII.

use std::fmt;

/// Holds something that's supposed to be mostly ASCII.
///
/// Some SDP values are allowed to be UTF-8-encoded ISO-10646 characters, but mostly it's
/// supposed to be valid ASCII. This has a `Debug` impl that is fairly readable for ASCII
/// characters and can be copy'n'pasted into Python's `codecs.decode(..., 'string_escape'`)`
/// or the like.
pub(crate) struct MostlyAscii<'a> {
    pub bytes: &'a [u8],
    pub escape_newline: bool,
}

impl<'a> MostlyAscii<'a> {
    pub fn new(bytes: &'a [u8]) -> Self {
        Self {
            bytes,
            escape_newline: false,
        }
    }
}

impl fmt::Debug for MostlyAscii<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "\"")?;
        for &b in self.bytes {
            match b {
                b'"' => write!(f, "\"")?,
                b'\r' => write!(f, "\\r")?,
                b'\n' if self.escape_newline => write!(f, "\\n")?,
                // Note: when escape_newline is false, newlines are written in unescaped form.
                b' ' | b'\n' | 0x20..=0x7E => write!(f, "{}", b as char)?,
                _ => write!(f, "\\x{b:02X}")?,
            }
        }
        write!(f, "\"")?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn basic_ascii() {
        let m = MostlyAscii::new(b"hello world");
        assert_eq!(format!("{m:?}"), "\"hello world\"");
    }

    #[test]
    fn newline_unescaped() {
        let m = MostlyAscii::new(b"line1\nline2");
        assert_eq!(format!("{m:?}"), "\"line1\nline2\"");
    }

    #[test]
    fn newline_escaped() {
        let m = MostlyAscii {
            bytes: b"line1\nline2",
            escape_newline: true,
        };
        assert_eq!(format!("{m:?}"), "\"line1\\nline2\"");
    }

    #[test]
    fn cr_always_escaped() {
        let m = MostlyAscii::new(b"line1\r\nline2");
        assert_eq!(format!("{m:?}"), "\"line1\\r\nline2\"");
    }

    #[test]
    fn non_ascii() {
        let m = MostlyAscii::new(b"hello\x80\xFF");
        assert_eq!(format!("{m:?}"), "\"hello\\x80\\xFF\"");
    }
}