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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
use std::cmp::Ordering;
use std::convert::Into;
use std::fmt;
use std::num::NonZeroU32;
use std::ops::Deref;
use std::str::FromStr;
use crate::helpers::make_4byte_bytes;
use crate::Error;
/// A tiny string that is from 1 to 4 non-NUL ASCII characters.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1: TinyStr4 = "Test".parse()
/// .expect("Failed to parse.");
///
/// assert_eq!(s1, "Test");
/// assert!(s1.is_ascii_alphabetic());
/// ```
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
pub struct TinyStr4(NonZeroU32);
impl TinyStr4 {
/// Creates a TinyStr4 from a byte slice.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1 = TinyStr4::from_bytes("Test".as_bytes())
/// .expect("Failed to parse.");
///
/// assert_eq!(s1, "Test");
/// ```
#[inline(always)]
pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error> {
unsafe {
match bytes.len() {
1 => make_4byte_bytes(bytes, 1, 0x80).map(Self),
2 => make_4byte_bytes(bytes, 2, 0x8080).map(Self),
3 => make_4byte_bytes(bytes, 3, 0x0080_8080).map(Self),
4 => make_4byte_bytes(bytes, 4, 0x8080_8080).map(Self),
_ => Err(Error::InvalidSize),
}
}
}
/// An unsafe constructor intended for cases where the consumer
/// guarantees that the input is a little endian integer which
/// is a correct representation of a `TinyStr4` string.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1: TinyStr4 = "Test".parse()
/// .expect("Failed to parse.");
///
/// let num: u32 = s1.into();
///
/// let s2 = unsafe { TinyStr4::new_unchecked(num) };
///
/// assert_eq!(s1, s2);
/// assert_eq!(s2.as_str(), "Test");
/// ```
///
/// # Safety
///
/// The method does not validate the `u32` to be properly encoded
/// value for `TinyStr4`.
/// The value can be retrieved via `Into<u32> for TinyStr4`.
#[inline(always)]
pub const unsafe fn new_unchecked(text: u32) -> Self {
Self(NonZeroU32::new_unchecked(u32::from_le(text)))
}
/// Extracts a string slice containing the entire `TinyStr4`.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1: TinyStr4 = "Test".parse()
/// .expect("Failed to parse.");
///
/// assert_eq!(s1.as_str(), "Test");
/// ```
#[inline(always)]
pub fn as_str(&self) -> &str {
self.deref()
}
/// Checks if the value is composed of ASCII alphabetic characters:
///
/// * U+0041 'A' ..= U+005A 'Z', or
/// * U+0061 'a' ..= U+007A 'z'.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1: TinyStr4 = "Test".parse()
/// .expect("Failed to parse.");
/// let s2: TinyStr4 = "Te3t".parse()
/// .expect("Failed to parse.");
///
/// assert!(s1.is_ascii_alphabetic());
/// assert!(!s2.is_ascii_alphabetic());
/// ```
pub fn is_ascii_alphabetic(self) -> bool {
let word = self.0.get();
let mask = (word + 0x7f7f_7f7f) & 0x8080_8080;
let lower = word | 0x2020_2020;
let alpha = !(lower + 0x1f1f_1f1f) | (lower + 0x0505_0505);
(alpha & mask) == 0
}
/// Checks if the value is composed of ASCII alphanumeric characters:
///
/// * U+0041 'A' ..= U+005A 'Z', or
/// * U+0061 'a' ..= U+007A 'z', or
/// * U+0030 '0' ..= U+0039 '9'.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1: TinyStr4 = "A15b".parse()
/// .expect("Failed to parse.");
/// let s2: TinyStr4 = "[3@w".parse()
/// .expect("Failed to parse.");
///
/// assert!(s1.is_ascii_alphanumeric());
/// assert!(!s2.is_ascii_alphanumeric());
/// ```
pub fn is_ascii_alphanumeric(self) -> bool {
let word = self.0.get();
let mask = (word + 0x7f7f_7f7f) & 0x8080_8080;
let numeric = !(word + 0x5050_5050) | (word + 0x4646_4646);
let lower = word | 0x2020_2020;
let alpha = !(lower + 0x1f1f_1f1f) | (lower + 0x0505_0505);
(alpha & numeric & mask) == 0
}
/// Checks if the value is composed of ASCII decimal digits:
///
/// * U+0030 '0' ..= U+0039 '9'.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1: TinyStr4 = "312".parse()
/// .expect("Failed to parse.");
/// let s2: TinyStr4 = "3d".parse()
/// .expect("Failed to parse.");
///
/// assert!(s1.is_ascii_numeric());
/// assert!(!s2.is_ascii_numeric());
/// ```
pub fn is_ascii_numeric(self) -> bool {
let word = self.0.get();
let mask = (word + 0x7f7f_7f7f) & 0x8080_8080;
let numeric = !(word + 0x5050_5050) | (word + 0x4646_4646);
(numeric & mask) == 0
}
/// Converts this type to its ASCII lower case equivalent in-place.
///
/// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z', other characters are unchanged.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1: TinyStr4 = "TeS3".parse()
/// .expect("Failed to parse.");
///
/// assert_eq!(s1.to_ascii_lowercase(), "tes3");
/// ```
pub fn to_ascii_lowercase(self) -> Self {
let word = self.0.get();
let result = word | (((word + 0x3f3f_3f3f) & !(word + 0x2525_2525) & 0x8080_8080) >> 2);
unsafe { Self(NonZeroU32::new_unchecked(result)) }
}
/// Converts this type to its ASCII title case equivalent in-place.
///
/// First character, if is an ASCII letter 'a' to 'z' is mapped to 'A' to 'Z',
/// other characters are unchanged.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1: TinyStr4 = "test".parse()
/// .expect("Failed to parse.");
///
/// assert_eq!(s1.to_ascii_titlecase(), "Test");
/// ```
pub fn to_ascii_titlecase(self) -> Self {
let word = self.0.get().to_le();
let mask = ((word + 0x3f3f_3f1f) & !(word + 0x2525_2505) & 0x8080_8080) >> 2;
let result = (word | mask) & !(0x20 & mask);
unsafe { Self(NonZeroU32::new_unchecked(u32::from_le(result))) }
}
/// Converts this type to its ASCII upper case equivalent in-place.
///
/// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z', other characters are unchanged.
///
/// # Examples
///
/// ```
/// use tinystr::TinyStr4;
///
/// let s1: TinyStr4 = "Tes3".parse()
/// .expect("Failed to parse.");
///
/// assert_eq!(s1.to_ascii_uppercase(), "TES3");
/// ```
pub fn to_ascii_uppercase(self) -> Self {
let word = self.0.get();
let result = word & !(((word + 0x1f1f_1f1f) & !(word + 0x0505_0505) & 0x8080_8080) >> 2);
unsafe { Self(NonZeroU32::new_unchecked(result)) }
}
}
impl fmt::Display for TinyStr4 {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", self.deref())
}
}
impl fmt::Debug for TinyStr4 {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{:?}", self.deref())
}
}
impl Deref for TinyStr4 {
type Target = str;
#[inline(always)]
fn deref(&self) -> &str {
// Again, could use #cfg to hand-roll a big-endian implementation.
let word = self.0.get().to_le();
let len = (4 - word.leading_zeros() / 8) as usize;
unsafe {
let slice = core::slice::from_raw_parts(&self.0 as *const _ as *const u8, len);
std::str::from_utf8_unchecked(slice)
}
}
}
impl PartialEq<&str> for TinyStr4 {
fn eq(&self, other: &&str) -> bool {
self.deref() == *other
}
}
impl PartialOrd for TinyStr4 {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
impl Ord for TinyStr4 {
fn cmp(&self, other: &Self) -> Ordering {
self.0.get().to_be().cmp(&other.0.get().to_be())
}
}
impl FromStr for TinyStr4 {
type Err = Error;
#[inline(always)]
fn from_str(text: &str) -> Result<Self, Self::Err> {
Self::from_bytes(text.as_bytes())
}
}
impl Into<u32> for TinyStr4 {
fn into(self) -> u32 {
self.0.get().to_le()
}
}