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
use std::borrow::Cow;
const LEGAL_CHARACTERS: [char; 10] = ['#', ';', '@', '!', '$', '%', '^', '&', '|', ':'];
/// A single comment from a `CommitMessage`
#[derive(Debug, PartialEq, Eq, Clone)]
pub struct Comment<'a> {
comment: Cow<'a, str>,
}
impl<'a> Comment<'a> {
/// Append one [`Comment`] onto another
///
/// This is for concatenating multiple [`Comment`] together
///
/// # Example
///
/// ```
/// use indoc::indoc;
/// use mit_commit::Comment;
///
/// assert_eq!(
/// Comment::from(indoc!(
/// "
/// Example 1
/// Example 2"
/// )),
/// Comment::from("Example 1").append(&Comment::from("Example 2"))
/// )
/// ```
#[must_use]
pub fn append(&self, additional: &Self) -> Self {
Self::from(format!("{}\n{}", self.comment, additional.comment))
}
/// Tells you if a given comment character is a potential comment character
///
/// # Example
///
/// ```
/// use mit_commit::Comment;
///
/// assert!(!Comment::is_legal_comment_char('?'),);
/// assert!(Comment::is_legal_comment_char('#'),);
/// ```
#[must_use]
pub fn is_legal_comment_char(character: char) -> bool {
LEGAL_CHARACTERS.contains(&character)
}
}
impl<'a> From<Cow<'a, str>> for Comment<'a> {
fn from(comment: Cow<'a, str>) -> Self {
Self { comment }
}
}
impl<'a> From<String> for Comment<'a> {
fn from(comment: String) -> Self {
Self {
comment: comment.into(),
}
}
}
impl<'a> From<&'a str> for Comment<'a> {
fn from(comment: &'a str) -> Self {
Self {
comment: comment.into(),
}
}
}
impl<'a> From<Comment<'a>> for String {
fn from(comment: Comment<'a>) -> Self {
comment.comment.into()
}
}