Skip to main content

OffsetMapping

Struct OffsetMapping 

Source
pub struct OffsetMapping {
    pub transformations: Vec<Transformation>,
    /* private fields */
}
Expand description

Offset mapping structure for tracking position changes during text filtering.

This structure maintains a list of all text transformations that occurred during character filtering, enabling accurate position mapping between filtered and original text.

§Usage Pattern

  1. Record transformations during filtering:
let mut mapping = OffsetMapping::new();
// When "㍑" → "リットル" transformation occurs:
mapping.add_transformation(Transformation::new(6, 9, 2, 14));
  1. Correct positions from filtered to original:
let original_pos = mapping.correct_offset(filtered_pos, text.len());

§Multi-Filter Support

When multiple character filters are applied, their mappings are composed:

let combined_mapping = mapping1.compose(mapping2);

This ensures accurate position tracking through complex filter chains.

Fields§

§transformations: Vec<Transformation>

List of transformations applied to the text

Implementations§

Source§

impl OffsetMapping

Source

pub fn new() -> Self

Source

pub fn with_transformations(transformations: Vec<Transformation>) -> Self

Source

pub fn add_transformation(&mut self, transformation: Transformation)

Add a transformation to the mapping

Source

pub fn is_empty(&self) -> bool

Check if this mapping is empty (no transformations)

Source

pub fn correct_offset(&self, offset: usize, text_len: usize) -> usize

Correct a position in filtered text to the corresponding position in original text.

This method maps a byte position in the filtered text back to the corresponding byte position in the original text, accounting for all recorded transformations.

§Arguments
  • offset - Byte position in the filtered text
  • text_len - Length of the filtered text (used for boundary validation)
§Returns

The corresponding byte position in the original text.

§Algorithm
  1. If no transformations exist, return the offset unchanged
  2. Find the transformation whose filtered range contains the offset
  3. Map the offset to the corresponding position in the original range
  4. If offset is outside all transformation ranges, adjust by cumulative differences
§Example
// For "10㍑" → "10リットル" with transformations recorded
let mut mapping = OffsetMapping::new();
mapping.add_transformation(Transformation::new(6, 9, 2, 14));

// Position 2 in "10リットル" ("リットル" start)
let original_pos = mapping.correct_offset(2, 14); // returns 6
// This maps to position 6 in "10㍑" ("㍑" start)
Source

pub fn compose(self, other: OffsetMapping) -> OffsetMapping

Compose this mapping with another mapping (for chaining filters)

Trait Implementations§

Source§

impl Clone for OffsetMapping

Source§

fn clone(&self) -> OffsetMapping

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OffsetMapping

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OffsetMapping

Source§

fn default() -> OffsetMapping

Returns the “default value” for a type. Read more
Source§

impl PartialEq for OffsetMapping

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OffsetMapping

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.