Struct str_index::StrIndex

pub struct StrIndex { /* fields omitted */ }

An index into a string.

The index is stored as a 32 bit integer, assuming we only deal with text shorter than 4 GiB.

Methods

impl StrIndex

pub fn from_char_len(c: char) -> Self

Index equal to the string length of this char.

Examples

assert_eq!(
    StrIndex::from_char_len('😂'),
    StrIndex::from(4),
);

pub fn from_str_len(s: &str) -> Self

Index equal to the length of this string.

Examples

assert_eq!(
    StrIndex::from_str_len("メカジキ"),
    StrIndex::from(12),
);

pub fn to_usize(self) -> usize

This index as a raw usize.

pub fn checked_add(self, rhs: Self) -> Option<Self>

Checked integer addition.

pub fn checked_sub(self, rhs: Self) -> Option<Self>

Checked integer subtraction.

pub fn range_for(self, len: StrIndex) -> StrRange

A range starting at this index.

Example

let point = StrIndex::from(5);
assert_eq!(
    point.range_for(10.into()),
    StrRange::from(5.into()..15.into()),
);

pub fn range_to(self, end: StrIndex) -> StrRange

A range from this index to another.

Panics

Panics if end < self.

Example

let start = StrIndex::from(0);
let end = StrIndex::from(10);
assert_eq!(
    start.range_to(end),
    StrRange::from(start..end),
);

pub fn as_unit_range(self) -> StrRange

The empty range at this index.

Example

let point = StrIndex::from(10);
assert_eq!(
    point.as_unit_range(),
    point.range_to(point),
);

Trait Implementations

impl From<StrIndex> for u32

fn from(idx: StrIndex) -> Self

Performs the conversion.

impl From<u32> for StrIndex

fn from(i: u32) -> Self

Performs the conversion.

impl From<StrIndex> for usize

fn from(idx: StrIndex) -> Self

Performs the conversion.

impl Debug for StrIndex

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

Formats the value using the given formatter.

impl Display for StrIndex

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

Formats the value using the given formatter.

impl Sub<StrIndex> for StrIndex

type Output = StrIndex

The resulting type after applying the - operator.

fn sub(self, rhs: StrIndex) -> StrIndex

Performs the - operation.

impl<'_> Sub<StrIndex> for &'_ StrIndex

type Output = StrIndex

The resulting type after applying the - operator.

fn sub(self, rhs: StrIndex) -> StrIndex

Performs the - operation.

impl<'_> Sub<&'_ StrIndex> for StrIndex

type Output = StrIndex

The resulting type after applying the - operator.

fn sub(self, rhs: &StrIndex) -> StrIndex

Performs the - operation.

impl<'_, '_> Sub<&'_ StrIndex> for &'_ StrIndex

type Output = StrIndex

The resulting type after applying the - operator.

fn sub(self, rhs: &StrIndex) -> StrIndex

Performs the - operation.

impl PartialEq<StrIndex> for StrIndex

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for StrIndex

impl Ord for StrIndex

fn cmp(&self, other: &StrIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<StrIndex> for StrIndex

fn partial_cmp(&self, other: &StrIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &StrIndex) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &StrIndex) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &StrIndex) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &StrIndex) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<usize> for StrIndex

type Error = <usize as TryInto<u32>>::Error

The type returned in the event of a conversion error.

fn try_from(i: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Add<StrIndex> for StrIndex

type Output = StrIndex

The resulting type after applying the + operator.

fn add(self, rhs: StrIndex) -> StrIndex

Performs the + operation.

impl<'_> Add<StrIndex> for &'_ StrIndex

type Output = StrIndex

The resulting type after applying the + operator.

fn add(self, rhs: StrIndex) -> StrIndex

Performs the + operation.

impl<'_> Add<&'_ StrIndex> for StrIndex

type Output = StrIndex

The resulting type after applying the + operator.

fn add(self, rhs: &StrIndex) -> StrIndex

Performs the + operation.

impl<'_, '_> Add<&'_ StrIndex> for &'_ StrIndex

type Output = StrIndex

The resulting type after applying the + operator.

fn add(self, rhs: &StrIndex) -> StrIndex

Performs the + operation.

impl<Rhs> AddAssign<Rhs> for StrIndex where
    Self: Add<Rhs, Output = Self>, 

fn add_assign(&mut self, rhs: Rhs)

Performs the += operation.

impl<Rhs> SubAssign<Rhs> for StrIndex where
    Self: Sub<Rhs, Output = Self>, 

fn sub_assign(&mut self, rhs: Rhs)

Performs the -= operation.

impl RangeBounds<StrIndex> for StrRange

fn start_bound(&self) -> Bound<&StrIndex>

Start index bound.

fn end_bound(&self) -> Bound<&StrIndex>

End index bound.

fn contains<U>(&self, item: &U) -> bool where
    T: PartialOrd<U>,
    U: PartialOrd<T> + ?Sized, 

Returns true if item is contained in the range.

impl Hash for StrIndex

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, 

Feeds a slice of this type into the given [Hasher].

impl Copy for StrIndex

impl StructuralPartialEq for StrIndex

impl StructuralEq for StrIndex

impl Clone for StrIndex

fn clone(&self) -> StrIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for StrIndex

fn default() -> StrIndex

Returns the "default value" for a type.