use std::cmp::Ordering; use std::convert::Into; use std::fmt; use std::num::NonZeroU64; use std::ops::Deref; use std::ptr::copy_nonoverlapping; use std::str::FromStr; use crate::Error; /// A tiny string that is from 1 to 8 non-NUL ASCII characters. /// /// # Examples /// /// ``` /// use tinystr::TinyStr8; /// /// let s1: TinyStr8 = "Testing".parse() /// .expect("Failed to parse."); /// /// assert_eq!(s1, "Testing"); /// assert!(s1.is_ascii_alphabetic()); /// ``` #[derive(Copy, Clone, PartialEq, Eq, Hash)] pub struct TinyStr8(NonZeroU64); impl TinyStr8 { /// Creates a TinyStr8 from a byte slice. /// /// # Examples /// /// ``` /// use tinystr::TinyStr8; /// /// let s1 = TinyStr8::from_bytes("Testing".as_bytes()) /// .expect("Failed to parse."); /// /// assert_eq!(s1, "Testing"); /// ``` #[inline(always)] pub fn from_bytes(bytes: &[u8]) -> Result { let len = bytes.len(); if len < 1 || len > 8 { return Err(Error::InvalidSize); } unsafe { let mut word: u64 = 0; copy_nonoverlapping(bytes.as_ptr(), &mut word as *mut u64 as *mut u8, len); let mask = 0x80808080_80808080u64 >> (8 * (8 - len)); // TODO: could do this with #cfg(target_endian), but this is clearer and // more confidence-inspiring. let mask = u64::from_le(mask); if (word & mask) != 0 { return Err(Error::NonAscii); } if ((mask - word) & mask) != 0 { return Err(Error::InvalidNull); } Ok(Self(NonZeroU64::new_unchecked(word))) } } /// 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 `TinyStr8` string. /// /// # Examples /// /// ``` /// use tinystr::TinyStr8; /// /// let s1: TinyStr8 = "Testing".parse() /// .expect("Failed to parse."); /// /// let num: u64 = s1.into(); /// /// let s2 = unsafe { TinyStr8::new_unchecked(num) }; /// /// assert_eq!(s1, s2); /// assert_eq!(s2.as_str(), "Testing"); /// ``` /// /// # Safety /// /// The method does not validate the `u64` to be properly encoded /// value for `TinyStr8`. /// The value can be retrieved via `Into for TinyStr8`. #[inline(always)] pub const unsafe fn new_unchecked(text: u64) -> Self { Self(NonZeroU64::new_unchecked(u64::from_le(text))) } /// Extracts a string slice containing the entire `TinyStr8`. /// /// # Examples /// /// ``` /// use tinystr::TinyStr8; /// /// let s1: TinyStr8 = "Testing".parse() /// .expect("Failed to parse."); /// /// assert_eq!(s1.as_str(), "Testing"); /// ``` #[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::TinyStr8; /// /// let s1: TinyStr8 = "Testing".parse() /// .expect("Failed to parse."); /// let s2: TinyStr8 = "Te3ting".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 + 0x7f7f7f7f_7f7f7f7f) & 0x80808080_80808080; let lower = word | 0x20202020_20202020; let alpha = !(lower + 0x1f1f1f1f_1f1f1f1f) | (lower + 0x05050505_05050505); (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::TinyStr8; /// /// let s1: TinyStr8 = "A15bing".parse() /// .expect("Failed to parse."); /// let s2: TinyStr8 = "[3@wing".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 + 0x7f7f7f7f_7f7f7f7f) & 0x80808080_80808080; let numeric = !(word + 0x50505050_50505050) | (word + 0x46464646_46464646); let lower = word | 0x20202020_20202020; let alpha = !(lower + 0x1f1f1f1f_1f1f1f1f) | (lower + 0x05050505_05050505); (alpha & numeric & mask) == 0 } /// Checks if the value is composed of ASCII decimal digits: /// /// * U+0030 '0' ..= U+0039 '9'. /// /// # Examples /// /// ``` /// use tinystr::TinyStr8; /// /// let s1: TinyStr8 = "3121029".parse() /// .expect("Failed to parse."); /// let s2: TinyStr8 = "3d212d".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 + 0x7f7f7f7f_7f7f7f7f) & 0x80808080_80808080; let numeric = !(word + 0x50505050_50505050) | (word + 0x46464646_46464646); (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::TinyStr8; /// /// let s1: TinyStr8 = "TeS3ing".parse() /// .expect("Failed to parse."); /// /// assert_eq!(s1.to_ascii_lowercase(), "tes3ing"); /// ``` pub fn to_ascii_lowercase(self) -> Self { let word = self.0.get(); let result = word | (((word + 0x3f3f3f3f_3f3f3f3f) & !(word + 0x25252525_25252525) & 0x80808080_80808080) >> 2); unsafe { Self(NonZeroU64::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::TinyStr8; /// /// let s1: TinyStr8 = "testing".parse() /// .expect("Failed to parse."); /// /// assert_eq!(s1.to_ascii_titlecase(), "Testing"); /// ``` pub fn to_ascii_titlecase(self) -> Self { let word = self.0.get().to_le(); let mask = ((word + 0x3f3f3f3f_3f3f3f1f) & !(word + 0x25252525_25252505) & 0x80808080_80808080) >> 2; let result = (word | mask) & !(0x20 & mask); unsafe { Self(NonZeroU64::new_unchecked(u64::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::TinyStr8; /// /// let s1: TinyStr8 = "Tes3ing".parse() /// .expect("Failed to parse."); /// /// assert_eq!(s1.to_ascii_uppercase(), "TES3ING"); /// ``` pub fn to_ascii_uppercase(self) -> Self { let word = self.0.get(); let result = word & !(((word + 0x1f1f1f1f_1f1f1f1f) & !(word + 0x05050505_05050505) & 0x80808080_80808080) >> 2); unsafe { Self(NonZeroU64::new_unchecked(result)) } } } impl fmt::Display for TinyStr8 { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.deref()) } } impl fmt::Debug for TinyStr8 { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{:?}", self.deref()) } } impl Deref for TinyStr8 { 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 = (8 - 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 TinyStr8 { fn eq(&self, other: &&str) -> bool { self.deref() == *other } } impl PartialOrd for TinyStr8 { fn partial_cmp(&self, other: &Self) -> Option { Some(self.cmp(other)) } } impl Ord for TinyStr8 { fn cmp(&self, other: &Self) -> Ordering { self.0.get().to_be().cmp(&other.0.get().to_be()) } } impl FromStr for TinyStr8 { type Err = Error; #[inline(always)] fn from_str(text: &str) -> Result { TinyStr8::from_bytes(text.as_bytes()) } } impl Into for TinyStr8 { fn into(self) -> u64 { self.0.get().to_le() } }