Struct ByteIndex 

pub struct ByteIndex(pub usize);

A byte offset into a UTF-8 string.

This is what you use to slice a str (e.g. &text[range.start.0..range.end.0]). Not to be confused with CharIndex, which counts characters instead of bytes.

Tuple Fields

0: usize

Implementations

impl ByteIndex

pub const ZERO: Self

The zero offset, i.e. the very start of the text.

pub fn saturating_add(self, rhs: usize) -> Self

Saturating integer addition.

pub fn saturating_sub(self, rhs: usize) -> Self

Saturating integer subtraction.

Trait Implementations

impl Add for ByteIndex

Compose offsets, e.g. a base position plus a relative one.

type Output = ByteIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for ByteIndex

type Output = ByteIndex

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self

Performs the + operation.

impl AddAssign for ByteIndex

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AddAssign<usize> for ByteIndex

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for ByteIndex

fn clone(&self) -> ByteIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ByteIndex

impl Debug for ByteIndex

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

Formats the value using the given formatter.

impl Default for ByteIndex

fn default() -> ByteIndex

Returns the “default value” for a type.

impl Display for ByteIndex

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

Formats the value using the given formatter.

impl Eq for ByteIndex

impl From<ByteIndex> for usize

fn from(index: ByteIndex) -> Self

Converts to this type from the input type.

impl From<usize> for ByteIndex

fn from(index: usize) -> Self

Converts to this type from the input type.

impl Hash for ByteIndex

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 Ord for ByteIndex

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ByteIndex

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ByteIndex

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for ByteIndex

impl Sub for ByteIndex

type Output = ByteIndex

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for ByteIndex

type Output = ByteIndex

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Self

Performs the - operation.

impl SubAssign<usize> for ByteIndex

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.