Struct SourceText

Source

pub struct SourceText { /* private fields */ }

Expand description

Represents source code text with line mapping and optional URL reference.

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

Text extraction at specific offsets or ranges
Character and line/column position tracking
LSP position and range conversions (when lsp-types feature is enabled)
Error reporting with precise location information

Implementations§

Source §

impl SourceText

Source

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: 4..5, text: "y".to_string() }];
let min_offset = source.apply_edits(&edits);
assert_eq!(min_offset, 4);

Source

pub fn view(&self, range: Range<usize>) -> SourceView<'_>

Creates a new SourceText containing a slice of the original text.

This method extracts a portion of the source text and creates a new SourceText instance with the extracted content. The line map is rebuilt for the new content.

§Arguments

range - The byte range to extract from the original text

§Returns

A new SourceText instance containing the extracted text slice

§Examples

let source = SourceText::new("fn main() {\n    println!(\"Hello\");\n}");
let slice = source.slice(0..12); // "fn main() {"

Source

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());

Source

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);

Source

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());

Source §

impl SourceText

Source

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() {}");

Source

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());

Source

pub fn lsp_to_text_edit(&self, edit: TextEdit) -> TextEdit

Converts an LSP TextEdit to a TextEdit.

§Arguments

edit - The LSP TextEdit to convert

§Returns

A TextEdit with byte-based span suitable for internal use.

§Availability

This method is only available when the lsp-types feature is enabled.

Source

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

Creates a kind error with location information.

§Arguments

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

§Returns

A PexError 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);

Creates a kind error with location information.

§Arguments

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

§Returns

A PexError 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);

Source

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

Creates an error for an unexpected character with location information.

§Arguments

character - The unexpected character
offset - The byte offset where the unexpected character was found

§Returns

A PexError with precise location information including line and column.

§Examples

let source = SourceText::new("let x@y = 5");
let error = source.unexpected_character('@', 6);

Source

pub fn get_location(&self, offset: usize) -> SourceLocation

Gets the source location for a given byte offset.

§Arguments

offset - The byte offset to get location for

§Returns

A SourceLocation with line, column, and optional URL information.

§Examples

let source = SourceText::new("line 1\nline 2\n");
let location = source.get_location(8); // Start of second line
assert_eq!(location.line, 2);
assert_eq!(location.column, 0);