zlink-core 0.4.1

The core crate of the zlink project
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

//! Comment definitions for Varlink interfaces.

use core::fmt;

/// A comment in a Varlink interface.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Comment<'a> {
    /// The comment text content (without the leading #).
    content: &'a str,
}

impl<'a> Comment<'a> {
    /// Creates a new comment with the given text content (without # prefix).
    pub const fn new(content: &'a str) -> Self {
        Self { content }
    }

    /// Returns the comment text content.
    pub fn content(&self) -> &'a str {
        self.content
    }

    /// Returns the comment text content.
    pub fn text(&self) -> &'a str {
        self.content
    }
}

impl<'a> fmt::Display for Comment<'a> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "# {}", self.content)
    }
}

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

    #[test]
    fn comment_creation() {
        let comment = Comment::new("This is a comment");
        assert_eq!(comment.content(), "This is a comment");
        assert_eq!(comment.text(), "This is a comment");
    }

    #[test]
    fn comment_without_hash() {
        let comment = Comment::new("This is not a proper comment");
        assert_eq!(comment.content(), "This is not a proper comment");
        assert_eq!(comment.text(), "This is not a proper comment");
    }

    #[test]
    fn comment_display() {
        let comment = Comment::new("A enum field allowing to gracefully get metadata");
        use core::fmt::Write;
        let mut buf = String::new();
        write!(buf, "{}", comment).unwrap();
        assert_eq!(
            buf.as_str(),
            "# A enum field allowing to gracefully get metadata"
        );
    }
}