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 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
//! This crate provides replacement types for [`String`] and [`&str`](`str`) that allow for safe
//! indexing by character to avoid panics and the usual pitfalls of working with multi-byte
//! UTF-8 characters, namely the scenario where the _byte length_ of a string and the
//! _character length_ of that same string are not the same.
//!
//! Specifically, [`IndexedString`] (replaces [`String`]) and [`IndexedSlice`] (replaces
//! [`&str`](`str`)) allow for O(1) slicing and indexing by character, and they will never panic
//! when indexing or slicing.
//!
//! This is accomplished by storing the character offsets of each character in the string,
//! along with the original [`String`], and using this information to calculate the byte
//! offsets of each character on the fly. Thus [`IndexedString`] uses ~2x the memory of a
//! normal [`String`], but [`IndexedSlice`] and other types implementing [`IndexedStr`] have
//! only one [`usize`] extra in overhead over that of a regular [`&str`](`str`) slice / fat
//! pointer. In theory this could be reduced down to the same size as a fat pointer using
//! unsafe rust, but this way we get to have completely safe code and the difference is
//! negligible.
//! # Examples
//!
//! ```
//! use safe_string::{IndexedString, IndexedStr, IndexedSlice};
//!
//! let message = IndexedString::from("Hello, 世界! 👋😊");
//! assert_eq!(message.as_str(), "Hello, 世界! 👋😊");
//! assert_eq!(message, "Hello, 世界! 👋😊"); // handy PartialEq impls
//!
//! // Access characters by index
//! assert_eq!(message.char_at(7), Some('世'));
//! assert_eq!(message.char_at(100), None); // Out of bounds access returns None
//!
//! // Slice the IndexedString
//! let slice = message.slice(7..9);
//! assert_eq!(slice.as_str(), "世界");
//!
//! // Convert slice back to IndexedString
//! let sliced_message = slice.to_indexed_string();
//! assert_eq!(sliced_message.as_str(), "世界");
//!
//! // Nested slicing
//! let slice = message.slice(0..10);
//! let nested_slice = slice.slice(3..6);
//! assert_eq!(nested_slice.as_str(), "lo,");
//!
//! // Display byte length and character length
//! assert_eq!(IndexedString::from_str("世界").byte_len(), 6); // "世界" is 6 bytes in UTF-8
//! assert_eq!(IndexedString::from_str("世界").len(), 2); // "世界" has 2 characters
//!
//! // Demonstrate clamped slicing (no panic)
//! let clamped_slice = message.slice(20..30);
//! assert_eq!(clamped_slice.as_str(), "");
//!
//! // Using `as_str` to interface with standard Rust string handling
//! let slice = message.slice(0..5);
//! let standard_str_slice = slice.as_str();
//! assert_eq!(standard_str_slice, "Hello");
//! ```
#![deny(missing_docs)]
use core::fmt::{Debug, Display};
use core::ops::{Bound, Index, RangeBounds};
/// A trait that facilitates safe interaction with strings that contain multi-byte characters.
///
/// [`IndexedString`] replaces [`String`], whereas [`IndexedSlice`] replaces [`&str`](`str`).
///
/// Both of these types as well as anything that implements [`IndexedStr`] are characterized by
/// the fact that their `len()` and indexing methods operate on characters, not bytes, and
/// enough information is stored to allow for O(1) slicing and indexing on a character _and_
/// byte basis as needed, but the default interface is character-centric.
///
/// This all comes at the cost of increased memory usage and some performance overhead when a
/// [`IndexedString`] is created, but the overhead is minimal when using [`IndexedSlice`] or
/// any other type implementing [`IndexedStr`].
///
/// It is also worth noting that all of these types will never panic when indexing or slicing,
/// unlike [`&str`](`str`) and [`String`], and clamped bounds are used instead.
pub trait IndexedStr:
Display + Debug + PartialEq<IndexedString> + for<'a> PartialEq<IndexedSlice<'a>> + Index<usize>
{
/// Returns a [`&str`](`str`) representation of this [`IndexedStr`].
///
/// WARNING: Once you cast to a [`&str`](`str`), you are leaving the safety provided by
/// [`IndexedStr`]. Only use this method when you need to interface with code that requires
/// a [`&str`](`str`).
fn as_str(&self) -> &str;
/// Returns a [`IndexedSlice`] that represents the entire contents of this [`IndexedStr`].
fn as_slice(&self) -> IndexedSlice;
/// Returns the length of this [`IndexedStr`] in characters, NOT bytes.
fn len(&self) -> usize;
/// Returns the byte length of this [`IndexedStr`]. This will be longer than the
/// [`len`](`IndexedStr::len`) if the string contains multi-byte characters.
fn byte_len(&self) -> usize;
/// Returns `true` if this [`IndexedStr`] is empty (of length 0).
fn is_empty(&self) -> bool {
self.len() == 0
}
/// Returns the character at the given index, if it exists.
fn char_at(&self, index: usize) -> Option<char>;
/// Returns a sub-slice of this [`IndexedStr`] based on the given range in terms of the
/// _characters_ in the string, not bytes.
///
/// The range is automatically clamped to the bounds of the [`IndexedStr`].
fn slice<R: RangeBounds<usize>>(&self, range: R) -> IndexedSlice;
/// Returns a slice containing all characters of this [`IndexedStr`] in order.
fn chars(&self) -> &[char];
/// Converts this [`IndexedStr`] into an owned, dynamically allocated [`IndexedString`].
fn to_indexed_string(&self) -> IndexedString;
/// Returns a new [`IndexedStr`] that is the lowercase version of this [`IndexedStr`].
fn to_lowercase(&self) -> IndexedString {
self.as_str().to_lowercase().into()
}
/// Returns a new [`IndexedStr`] that is the uppercase version of this [`IndexedStr`].
fn to_uppercase(&self) -> IndexedString {
self.as_str().to_uppercase().into()
}
}
/// A [`String`] replacement that allows for safe indexing and slicing of multi-byte characters.
///
/// This is the owned counterpart to [`IndexedSlice`].
#[derive(Clone, Debug, Eq, Hash)]
pub struct IndexedString {
chars: Vec<char>,
offsets: Vec<usize>,
string: String,
}
impl IndexedStr for IndexedString {
fn as_str(&self) -> &str {
&self.string
}
fn char_at(&self, index: usize) -> Option<char> {
self.chars.get(index).copied()
}
fn chars(&self) -> &[char] {
&self.chars[..]
}
fn len(&self) -> usize {
self.chars.len()
}
fn byte_len(&self) -> usize {
self.string.len()
}
fn slice<R: RangeBounds<usize>>(&self, range: R) -> IndexedSlice {
let start = match range.start_bound() {
Bound::Included(&start) => start,
Bound::Excluded(&start) => start + 1,
Bound::Unbounded => 0,
};
let end = match range.end_bound() {
Bound::Included(&end) => end + 1,
Bound::Excluded(&end) => end,
Bound::Unbounded => self.chars.len(),
};
let start = if start > self.chars.len() {
self.chars.len()
} else {
start
};
let end = if end > self.chars.len() {
self.chars.len()
} else {
end
};
IndexedSlice {
source: self,
start,
end,
}
}
fn to_indexed_string(&self) -> IndexedString {
self.clone()
}
fn as_slice(&self) -> IndexedSlice {
IndexedSlice {
source: self,
start: 0,
end: self.chars.len(),
}
}
}
impl IndexedString {
/// Creates a new [`IndexedString`] from a `&str` or anything that implements [`AsRef<str>`].
pub fn from_str(s: impl Display) -> Self {
IndexedString::from_string(s.to_string())
}
/// Creates a new [`IndexedString`] from a [`String`], avoiding the need to clone the
/// string by taking ownership of it.
pub fn from_string(s: String) -> Self {
IndexedString {
chars: s.to_string().chars().collect(),
offsets: s.to_string().char_indices().map(|(i, _)| i).collect(),
string: s.to_string(),
}
}
/// Creates a new [`IndexedString`] from an iterator of [`char`]s.
pub fn from_chars(chars: impl Iterator<Item = char>) -> Self {
let chars: Vec<char> = chars.collect();
let offsets: Vec<usize> = chars.iter().enumerate().map(|(i, _)| i).collect();
let string: String = chars.iter().collect();
IndexedString {
chars,
offsets,
string,
}
}
}
impl AsRef<str> for IndexedString {
fn as_ref(&self) -> &str {
&self.string
}
}
impl Index<usize> for IndexedString {
type Output = char;
fn index(&self, index: usize) -> &Self::Output {
&self.chars[index]
}
}
impl Display for IndexedString {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "{}", self.string)
}
}
impl<S: AsRef<str>> PartialEq<S> for IndexedString {
fn eq(&self, other: &S) -> bool {
self.string == other.as_ref()
}
}
/// A [`&str`](`str`) replacement that allows for safe indexing and slicing of multi-byte characters.
///
/// This is the borrowed counterpart to [`IndexedString`].
#[derive(Eq, Debug, Clone)]
pub struct IndexedSlice<'a> {
source: &'a IndexedString,
start: usize,
end: usize,
}
impl<'a> IndexedStr for IndexedSlice<'a> {
fn as_str(&self) -> &str {
if self.start >= self.source.offsets.len()
|| self.end > self.source.offsets.len()
|| self.start > self.end
{
return "";
}
let start_byte = self.source.offsets[self.start];
let end_byte = if self.end == self.source.offsets.len() {
self.source.string.len()
} else {
self.source.offsets[self.end]
};
&self.source.string[start_byte..end_byte]
}
fn len(&self) -> usize {
self.end - self.start
}
fn byte_len(&self) -> usize {
self.source.offsets[self.end] - self.source.offsets[self.start]
}
fn char_at(&self, index: usize) -> Option<char> {
self.source.char_at(self.start + index)
}
fn slice<R: RangeBounds<usize>>(&self, range: R) -> IndexedSlice {
let start = match range.start_bound() {
Bound::Included(&start) => start,
Bound::Excluded(&start) => start + 1,
Bound::Unbounded => 0,
};
let end = match range.end_bound() {
Bound::Included(&end) => end + 1,
Bound::Excluded(&end) => end,
Bound::Unbounded => self.len(),
};
let start = if start > self.len() {
self.len()
} else {
start
};
let end = if end > self.len() { self.len() } else { end };
IndexedSlice {
source: self.source,
start: self.start + start,
end: self.start + end,
}
}
fn chars(&self) -> &[char] {
&self.source.chars[self.start..self.end]
}
fn to_indexed_string(&self) -> IndexedString {
IndexedString::from_chars(self.chars().into_iter().copied())
}
fn as_slice(&self) -> IndexedSlice {
self.clone()
}
}
impl<'a, S: AsRef<str>> PartialEq<S> for IndexedSlice<'a> {
fn eq(&self, other: &S) -> bool {
self.as_str() == other.as_ref()
}
}
impl<'a> AsRef<str> for IndexedSlice<'a> {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl<'a> From<&'a IndexedString> for IndexedSlice<'a> {
fn from(s: &'a IndexedString) -> Self {
IndexedSlice {
source: s,
start: 0,
end: s.chars.len(),
}
}
}
impl<'a> From<IndexedSlice<'a>> for IndexedString {
fn from(s: IndexedSlice<'a>) -> Self {
s.to_indexed_string()
}
}
impl From<String> for IndexedString {
fn from(s: String) -> Self {
IndexedString::from_string(s)
}
}
impl From<&str> for IndexedString {
fn from(s: &str) -> Self {
IndexedString::from_str(s)
}
}
impl From<&String> for IndexedString {
fn from(s: &String) -> Self {
IndexedString::from_string(s.clone())
}
}
impl<'a> Display for IndexedSlice<'a> {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "{}", self.as_str())
}
}
impl Index<usize> for IndexedSlice<'_> {
type Output = char;
fn index(&self, index: usize) -> &Self::Output {
&self.source.chars[self.start + index]
}
}