Struct Offset 

pub struct Offset<S>
where
    S: Scale,
{ /* private fields */ }

An offset counted in a specific Scale.

The phantom parameter is the whole point: Offset<Bytes> and Offset<Chars> are distinct types, so the substitution that produced a wrong column for every non-ASCII user is now E0308.

raw() is deliberately the ONLY way out. Reaching for it is the moment to ask which scale the consumer wants, which is exactly the question the bare usize let everyone skip.

Implementations

impl<S> Offset<S>

where S: Scale,

pub const ZERO: Offset<S>

The start of the text, in any scale. Always valid.

pub const fn new(raw: usize) -> Offset<S>

pub const fn raw(self) -> usize

pub const fn scale_name() -> &'static str

Which ruler this was counted on — for diagnostics.

pub const fn advance(self, by: usize) -> Offset<S>

Move forward within the SAME scale. Saturating, so it cannot wrap.

Trait Implementations

impl<S> Clone for Offset<S>

where S: Scale,

fn clone(&self) -> Offset<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Copy for Offset<S>

where S: Scale,

impl<S> Debug for Offset<S>

where S: Debug + Scale,

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

Formats the value using the given formatter.

impl<S> Eq for Offset<S>

where S: Eq + Scale,

impl<S> Hash for Offset<S>

where S: Hash + Scale,

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<S> Ord for Offset<S>

where S: Ord + Scale,

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl<S> PartialEq for Offset<S>

where S: PartialEq + Scale,

fn eq(&self, other: &Offset<S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<S> PartialOrd for Offset<S>

where S: PartialOrd + Scale,

fn partial_cmp(&self, other: &Offset<S>) -> 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<S> StructuralPartialEq for Offset<S>

where S: PartialEq + Scale,