Struct CharOffset 

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

A character offset (Unicode scalar value index).

Use this newtype to prevent accidentally passing byte offsets where character offsets are expected. This is the most common source of Unicode-related bugs in NLP code.

Example

use anno::offset::CharOffset;

let text = "日本語";  // 3 chars, 9 bytes
let pos = CharOffset(1);  // Second character (本)
assert_eq!(pos.0, 1);

Tuple Fields

0: usize

Implementations

impl CharOffset

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

Create a new character offset.

pub const fn get(self) -> usize

Get the raw value.

Trait Implementations

impl Clone for CharOffset

fn clone(&self) -> CharOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CharOffset

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CharOffset

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CharOffset> for usize

fn from(offset: CharOffset) -> Self

Converts to this type from the input type.

impl From<usize> for CharOffset

fn from(offset: usize) -> Self

Converts to this type from the input type.

impl Hash for CharOffset

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 CharOffset

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

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

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

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 CharOffset

impl Eq for CharOffset

impl StructuralPartialEq for CharOffset