prdoclib 0.0.7

prdoclib is a lib
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

//! Title of a change

use serde::Serialize;
use std::{ffi::OsString, fmt::Display};

/// This struct is used to store the title of a change and provide functions to convert into an
/// OsString that can be used as filename.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Hash)]
pub struct Title(pub String);

impl Title {
	/// Convert a title to an OsString
	pub fn as_os_string(&self) -> OsString {
		OsString::from(self.0.replace(' ', "_"))
	}
}

impl Display for Title {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		f.write_str(&self.0)
	}
}

impl From<OsString> for Title {
	fn from(s: OsString) -> Self {
		Self(s.to_string_lossy().replace('_', " "))
	}
}

impl From<&str> for Title {
	fn from(s: &str) -> Self {
		Self(s.to_string())
	}
}

impl AsRef<str> for Title {
	#[inline(always)]
	fn as_ref(&self) -> &str {
		self.0.as_str()
	}
}

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

	#[test]
	fn test_from_str_with_spaces() {
		assert_eq!(OsString::from("foo_bar"), Title::from("foo bar").as_os_string());
	}

	#[test]
	fn test_from_str_with_emojis() {
		assert_eq!(OsString::from("foo_bar_😀"), Title::from("foo bar 😀").as_os_string());
	}

	#[test]
	fn test_from_os_string() {
		assert_eq!(
			"Original title".to_string(),
			Title::from(OsString::from("Original_title")).to_string()
		);
	}
}