Struct ByteOffset 

pub struct ByteOffset(/* private fields */);

0-based UTF-8 byte offset into source text.

Prefer TextSize for text_size::TextRange construction; this newtype marks raw parser byte offsets at crate boundaries.

Implementations

impl ByteOffset

pub const fn new(value: usize) -> Self

Creates a 0-based coordinate.

pub const fn get(self) -> usize

Returns the underlying numeric value for this coordinate.

Trait Implementations

impl Clone for ByteOffset

fn clone(&self) -> ByteOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ByteOffset

impl Debug for ByteOffset

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

Formats the value using the given formatter.

impl Display for ByteOffset

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

Formats the value using the given formatter.

impl Eq for ByteOffset

impl From<ByteOffset> for usize

fn from(value: ByteOffset) -> Self

Converts to this type from the input type.

impl From<TextSize> for ByteOffset

fn from(offset: TextSize) -> Self

Converts to this type from the input type.

impl From<usize> for ByteOffset

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for ByteOffset

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 ByteOffset

fn cmp(&self, other: &ByteOffset) -> 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 ByteOffset

fn eq(&self, other: &ByteOffset) -> 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 PartialOrd for ByteOffset

fn partial_cmp(&self, other: &ByteOffset) -> 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 ByteOffset

impl TryFrom<ByteOffset> for TextSize

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(offset: ByteOffset) -> Result<Self, Self::Error>

Performs the conversion.