mit-commit-message-lints 6.4.2

Check the correctness of a specific commit message. Designed to be used in tools providing commit-msg style hooks
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

use std::borrow::Cow;

use serde::{Deserialize, Serialize};

/// User input data for the relates to trailer
#[derive(Debug, Eq, PartialEq, Serialize, Deserialize, Clone)]
pub struct RelateTo<'a> {
    relates: Cow<'a, str>,
}

impl<'a> RelateTo<'a> {
    /// Create a new relates to
    #[must_use]
    pub const fn new(relates: Cow<'a, str>) -> Self {
        Self { relates }
    }

    /// What this relates to
    #[must_use]
    pub fn to(&self) -> &str {
        &self.relates
    }
}

impl<'a> From<&'a str> for RelateTo<'a> {
    fn from(input: &'a str) -> Self {
        RelateTo {
            relates: Cow::Borrowed(input),
        }
    }
}
impl From<String> for RelateTo<'_> {
    fn from(input: String) -> Self {
        RelateTo {
            relates: Cow::Owned(input),
        }
    }
}

#[cfg(test)]
mod tests {
    #![allow(clippy::wildcard_imports)]

    use crate::relates::RelateTo;

    #[test]
    fn test_convert_string_to_relate_to() {
        let relate = RelateTo::from("[#12343567]");

        assert_eq!(
            relate.to(),
            "[#12343567]",
            "Expected the relates-to value to match the string used to construct it"
        );
    }
}