Struct CodeUnitOffset 

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

Checked exact-text offset types owned by sim-text. An offset in the exact UTF-16 code-unit sequence.

This is intentionally not interchangeable with ScalarOffset.

use sim_text::{CodeUnitOffset, CodeUnitString, ScalarOffset};
let text = CodeUnitString::from_scalar("abc");
let scalar = ScalarOffset::new(1);
let _ = text.code_unit_at(scalar);

Implementations

impl CodeUnitOffset

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

Construct an offset. Bounds are checked when it is used with a value.

pub const fn get(self) -> usize

Return the numeric code-unit offset.

Trait Implementations

impl Clone for CodeUnitOffset

fn clone(&self) -> CodeUnitOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CodeUnitOffset

impl Debug for CodeUnitOffset

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

Formats the value using the given formatter.

impl Default for CodeUnitOffset

fn default() -> CodeUnitOffset

Returns the “default value” for a type.

impl Eq for CodeUnitOffset

impl Hash for CodeUnitOffset

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

where __H: Hasher,

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 CodeUnitOffset

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CodeUnitOffset

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