wt_blk 0.3.1

Parser and unpacker for the BLK file format
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use std::{
	borrow::Borrow,
	fmt::{Display, Formatter},
	ops::Deref,
	sync::Arc,
};

use serde::{Deserialize, Deserializer, Serialize, Serializer};

#[derive(Debug, Clone, PartialEq, Hash, Eq, PartialOrd)]
/// Efficient string wrapper for this specific application
pub struct BlkString {
	inner: Arc<String>,
}

impl BlkString {
	pub fn new(inner: impl Into<String>) -> Self {
		Self {
			inner: Arc::new(inner.into()),
		}
	}

	pub fn from_lossy(bytes: &[u8]) -> Self {
		Self {
			inner: (Arc::from(String::from_utf8_lossy(bytes).to_string())),
		}
	}

	/// This function should exclusively be used for accessing the string contents, as future
	/// optimizations will change the internals
	pub fn as_str(&self) -> &str {
		self.inner.as_str()
	}
}

impl Deref for BlkString {
	type Target = str;

	fn deref(&self) -> &Self::Target {
		self.as_str()
	}
}

impl Borrow<str> for BlkString {
	fn borrow(&self) -> &str {
		self.as_str()
	}
}

impl Display for BlkString {
	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
		write!(f, "{}", self.as_str())
	}
}

impl From<String> for BlkString {
	fn from(value: String) -> Self {
		Self::new(value)
	}
}

/// Wrapper for quickly creating Arced string
// TODO: use proper constructor instead
pub fn blk_str(s: impl Into<String>) -> BlkString {
	BlkString::from(s.into())
}

impl Serialize for BlkString {
	fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
	where
		S: Serializer, {
		serializer.serialize_str(self.as_str())
	}
}

impl<'de> Deserialize<'de> for BlkString {
	fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
	where
		D: Deserializer<'de>, {
		let s = String::deserialize(deserializer)?;
		Ok(BlkString { inner: Arc::new(s) })
	}
}

#[cfg(test)]
mod test {
	use crate::blk::blk_string::BlkString;

	#[test]
	pub fn serialize() {
		let sample = BlkString::from("test".to_owned());
		let ser = serde_json::to_string_pretty(&sample).unwrap();

		assert_eq!(ser.as_str(), "\"test\"");
	}

	#[test]
	pub fn deserialize() {
		assert_eq!(
			BlkString::from("test".to_owned()),
			serde_json::from_str("\"test\"").unwrap()
		);
	}
}