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
#[cfg(feature = "serde")]
pub extern crate serde;
#[cfg(feature = "compact")]
pub extern crate compact_str;
pub mod features;
/// case-insensitive string handling
#[cfg(not(feature = "compact"))]
#[derive(Debug, Clone, Default)]
#[repr(transparent)]
pub struct CaseInsensitiveString(String);
/// case-insensitive string handling
#[cfg(feature = "compact")]
#[derive(Debug, Clone, Default)]
#[repr(transparent)]
pub struct CaseInsensitiveString(compact_str::CompactString);
impl PartialEq for CaseInsensitiveString {
#[inline]
fn eq(&self, other: &Self) -> bool {
self.0.eq_ignore_ascii_case(&other.0)
}
}
impl Eq for CaseInsensitiveString {}
impl std::hash::Hash for CaseInsensitiveString {
#[inline]
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
self.0.to_ascii_lowercase().hash(state)
}
}
impl From<&str> for CaseInsensitiveString {
#[inline]
fn from(s: &str) -> Self {
CaseInsensitiveString { 0: s.into() }
}
}
#[cfg(feature = "compact")]
impl From<compact_str::CompactString> for CaseInsensitiveString {
#[inline]
fn from(s: compact_str::CompactString) -> Self {
CaseInsensitiveString { 0: s.into() }
}
}
impl From<String> for CaseInsensitiveString {
fn from(s: String) -> Self {
CaseInsensitiveString { 0: s.into() }
}
}
impl From<&[u8]> for CaseInsensitiveString {
fn from(s: &[u8]) -> Self {
CaseInsensitiveString {
0: String::from_utf8_lossy(s).into(),
}
}
}
impl AsRef<str> for CaseInsensitiveString {
#[inline]
fn as_ref(&self) -> &str {
&self.0
}
}
impl CaseInsensitiveString {
/// Creates a `CaseInsensitiveString` slice from any byte slice.
///
///
/// This is a cost-free conversion.
///
/// # Example
///
/// You can create `CaseInsensitiveString`'s from byte arrays, byte slices or string slices:
///
/// ```
/// use case_insensitive_string::CaseInsensitiveString;
///
/// let a = CaseInsensitiveString::new(b"abc");
/// let b = CaseInsensitiveString::new("abc");
///
/// assert_eq!(a, b);
/// ```
#[inline]
pub fn new<'a, B: ?Sized + AsRef<[u8]>>(bytes: &'a B) -> CaseInsensitiveString {
CaseInsensitiveString::from(bytes.as_ref())
}
#[inline]
pub fn as_bytes(&self) -> &[u8] {
&self.0.as_bytes()
}
#[cfg(not(feature = "compact"))]
#[inline]
pub fn inner(&self) -> &String {
&self.0
}
#[cfg(feature = "compact")]
#[inline]
pub fn inner(&self) -> &compact_str::CompactString {
&self.0
}
/// Appends the given [`char`] to the end of this [`CaseInsensitiveString`].
///
/// # Examples
/// ```
/// # use case_insensitive_string::CaseInsensitiveString;
/// let mut s = CaseInsensitiveString::new("foo");
///
/// s.push('b');
/// s.push('a');
/// s.push('r');
///
/// assert_eq!(CaseInsensitiveString::from("foobar"), s);
/// ```
pub fn push(&mut self, ch: char) {
self.push_str(ch.encode_utf8(&mut [0; 4]));
}
/// Appends a given string slice onto the end of this [`CaseInsensitiveString`]
///
/// # Examples
/// ```
/// # use case_insensitive_string::CaseInsensitiveString;
/// let mut s = CaseInsensitiveString::new("abc");
///
/// s.push_str("123");
///
/// assert_eq!(CaseInsensitiveString::new("abc123"), s);
/// ```
#[inline]
pub fn push_str(&mut self, s: &str) {
self.0.push_str(s)
}
/// Removes a [`char`] from this [`CaseInsensitiveString`] at a byte position and returns it.
///
/// This is an *O*(*n*) operation, as it requires copying every element in the
/// buffer.
///
/// # Panics
///
/// Panics if `idx` is larger than or equal to the [`CaseInsensitiveString`]'s length,
/// or if it does not lie on a [`char`] boundary.
///
/// # Examples
///
/// ### Basic usage:
///
/// ```
/// # use case_insensitive_string::CaseInsensitiveString;
/// let mut c = CaseInsensitiveString::from("hello world");
///
/// assert_eq!(c.remove(0), 'h');
/// assert_eq!(c, "ello world".into());
///
/// assert_eq!(c.remove(5), 'w');
/// assert_eq!(c, "ello orld".into());
/// ```
///
/// ### Past total length:
///
/// ```should_panic
/// # use case_insensitive_string::CaseInsensitiveString;
/// let mut c = CaseInsensitiveString::from("hello there!");
/// c.remove(100);
/// ```
///
/// ### Not on char boundary:
///
/// ```should_panic
/// # use case_insensitive_string::CaseInsensitiveString;
/// let mut c = CaseInsensitiveString::from("🦄");
/// c.remove(1);
/// ```
#[inline]
pub fn remove(&mut self, idx: usize) -> char {
self.0.remove(idx)
}
/// Returns the length of the [`CaseInsensitiveString`] in `bytes`, not [`char`]s or graphemes.
///
/// When using `UTF-8` encoding (which all strings in Rust do) a single character will be 1 to 4
/// bytes long, therefore the return value of this method might not be what a human considers
/// the length of the string.
///
/// # Examples
/// ```
/// # use case_insensitive_string::CaseInsensitiveString;
/// let ascii = CaseInsensitiveString::new("hello world");
/// assert_eq!(ascii.len(), 11);
///
/// let emoji = CaseInsensitiveString::new("👱");
/// assert_eq!(emoji.len(), 4);
/// ```
#[inline]
pub fn len(&self) -> usize {
self.0.len()
}
/// Returns `true` if the [`CaseInsensitiveString`] has a length of 0, `false` otherwise
///
/// # Examples
/// ```
/// # use case_insensitive_string::CaseInsensitiveString;
/// let mut msg = CaseInsensitiveString::new("");
/// assert!(msg.is_empty());
///
/// // add some characters
/// msg.push_str("hello reader!");
/// assert!(!msg.is_empty());
/// ```
#[inline]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
}