Struct SourceText 

pub struct SourceText { /* private fields */ }

Represents source code text with optional URL reference.

This struct manages the raw source text and provides utilities for:

• Text extraction at specific offsets or ranges
• Error reporting with precise location information

Implementations

impl SourceText

pub fn text(&self) -> &str

Returns the raw source text as a string slice.

pub fn apply_edits_range(&mut self, edits: &[TextEdit]) -> Range<usize>

Applies multiple text edits to the source text and returns the affected range.

pub fn apply_edits(&mut self, edits: &[TextEdit]) -> usize

Applies multiple text edits to the source text and returns the minimum affected offset.

This method is used for incremental updates to source code, such as those received from LSP clients or other text editing operations.

Arguments

• edits - A slice of TextEdit operations to apply

Returns

The minimum byte offset that was affected by any of the edits. This is useful for determining where to restart parsing after incremental changes.

Examples

let mut source = SourceText::new("let x = 5;");
let edits = vec![TextEdit { span: Range { start: 4, end: 5 }, text: "y".to_string() }];
let min_offset = source.apply_edits(&edits);
assert_eq!(min_offset, 4);

pub fn get_url(&self) -> Option<&Url>

Gets the URL associated with this source text, if any.

Returns

An Option<&Url> containing the URL reference if one was set, or None if no URL is associated with this source text.

Examples

let source = SourceText::new_with_url("code", Url::parse("file:///main.rs").unwrap());
assert!(source.get_url().is_some());

pub fn len(&self) -> usize

Gets the length of the source text in bytes.

Returns

The length of the source text in bytes.

Examples

let source = SourceText::new("Hello, world!");
assert_eq!(source.len(), 13);

pub fn is_empty(&self) -> bool

Checks if the source text is empty.

Returns

true if the source text is empty, false otherwise.

Examples

let source = SourceText::new("");
assert!(source.is_empty());

impl SourceText

pub fn new(input: impl ToString) -> Self

Creates a new SourceText from a string.

Arguments

• input - The source code text

Examples

let source = SourceText::new("fn main() {}");

pub fn new_with_url(input: impl ToString, url: Url) -> Self

Creates a new SourceText from a string with an optional URL.

Arguments

• input - The source code text
• url - URL reference for the source file

Examples

let source = SourceText::new_with_url("fn main() {}", Url::parse("file:///main.rs").unwrap());

pub fn syntax_error( &self, message: impl Into<String>, offset: usize, ) -> OakError

Creates a syntax error with location information.

Arguments

• message - The error message
• offset - The byte offset where the error occurred

Returns

An OakError with precise location information including line and column.

Examples

let source = SourceText::new("let x =");
let error = source.syntax_error("Unexpected end of input", 7);

pub fn unexpected_character(&self, character: char, offset: usize) -> OakError

Creates an error for an unexpected character at the specified offset.

pub fn expected_token( &self, expected: impl Into<String>, offset: usize, ) -> OakError

Creates an error for an expected token that was missing at the specified offset.

pub fn expected_name( &self, name_kind: impl Into<String>, offset: usize, ) -> OakError

Creates an error for an expected name that was missing at the specified offset.

pub fn trailing_comma_not_allowed(&self, offset: usize) -> OakError

Creates an error for a trailing comma that is not allowed at the specified offset.

Trait Implementations

impl Clone for SourceText

fn clone(&self) -> SourceText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceText

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

Formats the value using the given formatter.

impl Default for SourceText

fn default() -> SourceText

Returns the “default value” for a type.

impl Hash for SourceText

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 PartialEq for SourceText

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

fn length(&self) -> usize

Get the length of this source.

fn chunk_at(&self, offset: usize) -> TextChunk<'_>

Returns a text chunk containing the specified offset.

fn get_text_in(&self, range: Range<usize>) -> Cow<'_, str>

Get the text content at the specified range.

fn get_url(&self) -> Option<&Url>

Get the URL of this source, if available.

fn url(&self) -> Option<Url>

Returns the URL of this source, if available.

fn is_empty(&self) -> bool

Check if the source is empty.

fn get_char_at(&self, offset: usize) -> Option<char>

Get a single character at the specified offset.

fn get_text_from(&self, offset: usize) -> Cow<'_, str>

Get the text from the current position to the end of the source.

fn find_char_from(&self, offset: usize, ch: char) -> Option<usize>

Find the next occurrence of a character starting from an offset.

fn find_str_from(&self, offset: usize, pattern: &str) -> Option<usize>

Find the next occurrence of a substring starting from an offset.

fn syntax_error(&self, message: String, offset: usize) -> OakError

Create a syntax error with location information.

impl Eq for SourceText

impl StructuralPartialEq for SourceText