Skip to main content

SourceText

Struct SourceText 

Source
pub struct SourceText { /* private fields */ }
Expand description

Immutable source text with checked UTF-8 byte and UTF-16 coordinate mapping.

The map records only boundaries immediately after non-ASCII code points. Between checkpoints, byte and UTF-16 offsets advance together through ASCII, so binary search plus one subtraction converts either direction without a per-code-point map.

Implementations§

Source§

impl SourceText

Source

pub fn new(text: impl Into<Arc<str>>) -> Self

Stores source text and precomputes its immutable position indexes.

Source

pub fn from_arc(text: Arc<str>) -> Self

Stores an existing shared source allocation without copying its text.

Source

pub fn as_str(&self) -> &str

Returns the original UTF-8 source text.

Source

pub const fn len_utf16(&self) -> Utf16Pos

Returns the source length in UTF-16 code units.

Source

pub fn is_empty(&self) -> bool

Returns whether the source has no code points.

Source

pub fn byte_to_utf16( &self, byte_offset: usize, ) -> Result<Utf16Pos, SourcePositionError>

Converts a UTF-8 byte boundary to a UTF-16 boundary.

Source

pub fn utf16_to_byte( &self, position: Utf16Pos, ) -> Result<usize, SourcePositionError>

Converts a UTF-16 boundary to a UTF-8 byte boundary.

Source

pub fn range( &self, start: Utf16Pos, end: Utf16Pos, ) -> Result<TextRange, SourcePositionError>

Returns a source-relative, ordered range after validating both endpoints.

Source

pub fn line_column( &self, position: Utf16Pos, ) -> Result<(usize, usize), SourcePositionError>

Returns the zero-based line and UTF-16 column of a valid source boundary.

\r\n contributes one line break, with the next line beginning after the \n. A bare \r, a bare \n, \u{2028} (LINE SEPARATOR), and \u{2029} (PARAGRAPH SEPARATOR) each also begin a new line.

Trait Implementations§

Source§

impl Clone for SourceText

Source§

fn clone(&self) -> SourceText

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 SourceText

Source§

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

Formats the value using the given formatter. Read more

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> 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> 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.