Struct ByteOffset 

#[repr(transparent)]
pub struct ByteOffset(pub usize);

A byte offset (raw byte index into UTF-8 string).

Use this newtype to prevent accidentally passing character offsets where byte offsets are expected. Byte offsets are what Rust’s str::get() and regex libraries return.

Example

use anno::offset::ByteOffset;

let text = "日本語";  // 3 chars, 9 bytes
let pos = ByteOffset(3);  // Start of second character (本)
assert_eq!(pos.0, 3);

Tuple Fields

0: usize

Implementations

impl ByteOffset

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

Create a new byte offset.

pub const fn get(self) -> usize

Get the raw value.

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 Debug for ByteOffset

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ByteOffset

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ByteOffset> for usize

fn from(offset: ByteOffset) -> Self

Converts to this type from the input type.

impl From<usize> for ByteOffset

fn from(offset: 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 Serialize for ByteOffset

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ByteOffset

impl Eq for ByteOffset

impl StructuralPartialEq for ByteOffset