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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
use smallvec::{smallvec, SmallVec};
use std::ffi::{CStr, CString, NulError};
/// Similar to `std::ffi::CString`, but avoids heap allocating if the string is
/// small enough. Also guarantees it's input is UTF-8 -- used for cases where we
/// need to pass a NUL-terminated string to SQLite, and we have a `&str`.
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord)]
pub(crate) struct SmallCString(SmallVec<[u8; 16]>);
impl SmallCString {
#[inline]
pub fn new(s: &str) -> Result<Self, NulError> {
if s.as_bytes().contains(&0_u8) {
return Err(Self::fabricate_nul_error(s));
}
let mut buf = SmallVec::with_capacity(s.len() + 1);
buf.extend_from_slice(s.as_bytes());
buf.push(0);
let res = Self(buf);
res.debug_checks();
Ok(res)
}
#[inline]
pub fn as_str(&self) -> &str {
self.debug_checks();
// Constructor takes a &str so this is safe.
unsafe { std::str::from_utf8_unchecked(self.as_bytes_without_nul()) }
}
/// Get the bytes not including the NUL terminator. E.g. the bytes which
/// make up our `str`:
/// - `SmallCString::new("foo").as_bytes_without_nul() == b"foo"`
/// - `SmallCString::new("foo").as_bytes_with_nul() == b"foo\0"`
#[inline]
pub fn as_bytes_without_nul(&self) -> &[u8] {
self.debug_checks();
&self.0[..self.len()]
}
/// Get the bytes behind this str *including* the NUL terminator. This
/// should never return an empty slice.
#[inline]
pub fn as_bytes_with_nul(&self) -> &[u8] {
self.debug_checks();
&self.0
}
#[inline]
#[cfg(debug_assertions)]
fn debug_checks(&self) {
debug_assert_ne!(self.0.len(), 0);
debug_assert_eq!(self.0[self.0.len() - 1], 0);
let strbytes = &self.0[..(self.0.len() - 1)];
debug_assert!(!strbytes.contains(&0));
debug_assert!(std::str::from_utf8(strbytes).is_ok());
}
#[inline]
#[cfg(not(debug_assertions))]
fn debug_checks(&self) {}
#[inline]
pub fn len(&self) -> usize {
debug_assert_ne!(self.0.len(), 0);
self.0.len() - 1
}
#[inline]
#[allow(unused)] // clippy wants this function.
pub fn is_empty(&self) -> bool {
self.len() == 0
}
#[inline]
pub fn as_cstr(&self) -> &CStr {
let bytes = self.as_bytes_with_nul();
debug_assert!(CStr::from_bytes_with_nul(bytes).is_ok());
unsafe { CStr::from_bytes_with_nul_unchecked(bytes) }
}
#[cold]
fn fabricate_nul_error(b: &str) -> NulError {
CString::new(b).unwrap_err()
}
}
impl Default for SmallCString {
#[inline]
fn default() -> Self {
Self(smallvec![0])
}
}
impl std::fmt::Debug for SmallCString {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_tuple("SmallCString").field(&self.as_str()).finish()
}
}
impl std::ops::Deref for SmallCString {
type Target = CStr;
#[inline]
fn deref(&self) -> &CStr {
self.as_cstr()
}
}
impl PartialEq<SmallCString> for str {
#[inline]
fn eq(&self, s: &SmallCString) -> bool {
s.as_bytes_without_nul() == self.as_bytes()
}
}
impl PartialEq<str> for SmallCString {
#[inline]
fn eq(&self, s: &str) -> bool {
self.as_bytes_without_nul() == s.as_bytes()
}
}
impl std::borrow::Borrow<str> for SmallCString {
#[inline]
fn borrow(&self) -> &str {
self.as_str()
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_small_cstring() {
// We don't go through the normal machinery for default, so make sure
// things work.
assert_eq!(SmallCString::default().0, SmallCString::new("").unwrap().0);
assert_eq!(SmallCString::new("foo").unwrap().len(), 3);
assert_eq!(
SmallCString::new("foo").unwrap().as_bytes_with_nul(),
b"foo\0"
);
assert_eq!(
SmallCString::new("foo").unwrap().as_bytes_without_nul(),
b"foo",
);
assert_eq!(SmallCString::new("😀").unwrap().len(), 4);
assert_eq!(
SmallCString::new("😀").unwrap().0.as_slice(),
b"\xf0\x9f\x98\x80\0",
);
assert_eq!(
SmallCString::new("😀").unwrap().as_bytes_without_nul(),
b"\xf0\x9f\x98\x80",
);
assert_eq!(SmallCString::new("").unwrap().len(), 0);
assert!(SmallCString::new("").unwrap().is_empty());
assert_eq!(SmallCString::new("").unwrap().0.as_slice(), b"\0");
assert_eq!(SmallCString::new("").unwrap().as_bytes_without_nul(), b"");
assert!(SmallCString::new("\0").is_err());
assert!(SmallCString::new("\0abc").is_err());
assert!(SmallCString::new("abc\0").is_err());
}
}
|
