Struct IndexedString

pub struct IndexedString { /* private fields */ }

A String replacement that allows for safe indexing and slicing of multi-byte characters.

This is the owned counterpart to IndexedSlice.

Implementations

impl IndexedString

pub fn from_str(s: impl Display) -> Self

Creates a new IndexedString from a &str or anything that implements Display.

pub fn from_string(s: String) -> Self

Creates a new IndexedString from a String, avoiding the need to clone the string by taking ownership of it.

pub fn from_chars(chars: impl Iterator<Item = char>) -> Self

Creates a new IndexedString from an iterator of chars.

Trait Implementations

impl AsRef<str> for IndexedString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for IndexedString

fn clone(&self) -> IndexedString

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IndexedString

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for IndexedString

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> From<&'a IndexedString> for IndexedSlice<'a>

fn from(s: &'a IndexedString) -> Self

Converts to this type from the input type.

impl From<&String> for IndexedString

fn from(s: &String) -> Self

Converts to this type from the input type.

impl From<&str> for IndexedString

fn from(s: &str) -> Self

Converts to this type from the input type.

impl<'a> From<IndexedSlice<'a>> for IndexedString

fn from(s: IndexedSlice<'a>) -> Self

Converts to this type from the input type.

impl From<String> for IndexedString

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for IndexedString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IndexedStr for &IndexedString

fn as_str(&self) -> &str

Returns a &str representation of this IndexedStr.

fn as_slice(&self) -> IndexedSlice<'_>

Returns a IndexedSlice that represents the entire contents of this IndexedStr.

fn len(&self) -> usize

Returns the length of this IndexedStr in characters, NOT bytes.

fn byte_len(&self) -> usize

Returns the byte length of this IndexedStr. This will be longer than the len if the string contains multi-byte characters.

fn char_at(&self, index: usize) -> Option<char>

Returns the character at the given index, if it exists.

fn slice<R: RangeBounds<usize>>(&self, range: R) -> IndexedSlice<'_>

Returns a sub-slice of this IndexedStr based on the given range in terms of the characters in the string, not bytes.

fn chars(&self) -> &[char]

Returns a slice containing all characters of this IndexedStr in order.

fn to_indexed_string(&self) -> IndexedString

Converts this IndexedStr into an owned, dynamically allocated IndexedString.

fn lines(&self) -> IndexedLines<'_>

Returns an iterator over the lines of this IndexedStr.

fn is_empty(&self) -> bool

Returns true if this IndexedStr is empty (of length 0).

fn to_lowercase(&self) -> IndexedString

Returns a new IndexedStr that is the lowercase version of this IndexedStr.

fn to_uppercase(&self) -> IndexedString

Returns a new IndexedStr that is the uppercase version of this IndexedStr.

fn starts_with<S: AsRef<str>>(&self, s: S) -> bool

Returns true if this IndexedStr starts with the given string.

fn ends_with<S: AsRef<str>>(&self, s: S) -> bool

Returns true if this IndexedStr ends with the given string.

fn parse<F>(&self) -> Result<F, <F as FromStr>::Err>

where F: FromStr,

Parses this IndexedStr into a value of type F using the FromStr trait.

impl IndexedStr for IndexedString

fn as_str(&self) -> &str

Returns a &str representation of this IndexedStr.

fn char_at(&self, index: usize) -> Option<char>

Returns the character at the given index, if it exists.

fn chars(&self) -> &[char]

Returns a slice containing all characters of this IndexedStr in order.

fn len(&self) -> usize

Returns the length of this IndexedStr in characters, NOT bytes.

fn byte_len(&self) -> usize

Returns the byte length of this IndexedStr. This will be longer than the len if the string contains multi-byte characters.

fn slice<R: RangeBounds<usize>>(&self, range: R) -> IndexedSlice<'_>

Returns a sub-slice of this IndexedStr based on the given range in terms of the characters in the string, not bytes.

fn to_indexed_string(&self) -> IndexedString

Converts this IndexedStr into an owned, dynamically allocated IndexedString.

fn as_slice(&self) -> IndexedSlice<'_>

Returns a IndexedSlice that represents the entire contents of this IndexedStr.

fn lines(&self) -> IndexedLines<'_>

Returns an iterator over the lines of this IndexedStr.

fn is_empty(&self) -> bool

Returns true if this IndexedStr is empty (of length 0).

fn to_lowercase(&self) -> IndexedString

Returns a new IndexedStr that is the lowercase version of this IndexedStr.

fn to_uppercase(&self) -> IndexedString

Returns a new IndexedStr that is the uppercase version of this IndexedStr.

fn starts_with<S: AsRef<str>>(&self, s: S) -> bool

Returns true if this IndexedStr starts with the given string.

fn ends_with<S: AsRef<str>>(&self, s: S) -> bool

Returns true if this IndexedStr ends with the given string.

fn parse<F>(&self) -> Result<F, <F as FromStr>::Err>

where F: FromStr,

Parses this IndexedStr into a value of type F using the FromStr trait.

impl PartialEq<IndexedSlice<'_>> for &IndexedString

fn eq(&self, other: &IndexedSlice<'_>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<IndexedString> for &IndexedSlice<'_>

fn eq(&self, other: &IndexedString) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<IndexedString> for &IndexedString

fn eq(&self, other: &IndexedString) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<IndexedString> for &str

fn eq(&self, other: &IndexedString) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<IndexedString> for String

fn eq(&self, other: &IndexedString) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: AsRef<str>> PartialEq<S> for IndexedString

fn eq(&self, other: &S) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for IndexedString