Trait safe_string::IndexedStr

source ·

pub trait IndexedStr: Display + Debug + PartialEq<IndexedString> + for<'a> PartialEq<IndexedSlice<'a>> + Index<usize> {
    // Required methods
    fn as_str(&self) -> &str;
    fn len(&self) -> usize;
    fn byte_len(&self) -> usize;
    fn char_at(&self, index: usize) -> Option<char>;
    fn slice<R: RangeBounds<usize>>(&self, range: R) -> IndexedSlice<'_>;
    fn chars(&self) -> &[char];
    fn to_indexed_string(&self) -> IndexedString;
}

Expand description

A trait that facilitates safe interaction with strings that contain multi-byte characters.

IndexedString replaces String, whereas IndexedSlice replaces &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 and String, and clamped bounds are used instead.

Required Methods§

source

fn as_str(&self) -> &str

Returns a &str representation of this IndexedStr.

WARNING: Once you cast to a &str, you are leaving the safety provided by IndexedStr. Only use this method when you need to interface with code that requires a &str.

source