Struct Source

pub struct Source(/* private fields */);

A source file.

All line and column indices start at zero, just like byte indices. Only for user-facing display, you should add 1 to them.

Values of this type are cheap to clone and hash.

Implementations

impl Source

pub fn new(id: FileId, text: String) -> Self

Create a new source file.

pub fn detached(text: impl Into<String>) -> Self

Create a source file without a real id and path, usually for testing.

pub fn root(&self) -> &SyntaxNode

The root node of the file’s untyped syntax tree.

pub fn id(&self) -> FileId

The id of the source file.

pub fn text(&self) -> &str

The whole source as a string slice.

pub fn get(&self, range: Range<usize>) -> Option<&str>

Slice out the part of the source code enclosed by the range.

pub fn replace(&mut self, new: &str) -> Range<usize>

Fully replace the source text.

This performs a naive (suffix/prefix-based) diff of the old and new text to produce the smallest single edit that transforms old into new and then calls edit with it.

Returns the range in the new source that was ultimately reparsed.

pub fn edit(&mut self, replace: Range<usize>, with: &str) -> Range<usize>

Edit the source file by replacing the given range.

Returns the range in the new source that was ultimately reparsed.

The method panics if the replace range is out of bounds.

pub fn len_bytes(&self) -> usize

Get the length of the file in UTF-8 encoded bytes.

pub fn len_utf16(&self) -> usize

Get the length of the file in UTF-16 code units.

pub fn len_lines(&self) -> usize

Get the length of the file in lines.

pub fn find(&self, span: Span) -> Option<LinkedNode<'_>>

Find the node with the given span.

Returns None if the span does not point into this source file.

pub fn range(&self, span: Span) -> Option<Range<usize>>

Get the byte range for the given span in this file.

Returns None if the span does not point into this source file.

pub fn byte_to_utf16(&self, byte_idx: usize) -> Option<usize>

Return the index of the UTF-16 code unit at the byte index.

pub fn byte_to_line(&self, byte_idx: usize) -> Option<usize>

Return the index of the line that contains the given byte index.

pub fn byte_to_column(&self, byte_idx: usize) -> Option<usize>

Return the index of the column at the byte index.

The column is defined as the number of characters in the line before the byte index.

pub fn utf16_to_byte(&self, utf16_idx: usize) -> Option<usize>

Return the byte index at the UTF-16 code unit.

pub fn line_to_byte(&self, line_idx: usize) -> Option<usize>

Return the byte position at which the given line starts.

pub fn line_to_range(&self, line_idx: usize) -> Option<Range<usize>>

Return the range which encloses the given line.

pub fn line_column_to_byte( &self, line_idx: usize, column_idx: usize, ) -> Option<usize>

Return the byte index of the given (line, column) pair.

The column defines the number of characters to go beyond the start of the line.

Trait Implementations

impl AsRef<str> for Source

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl Hash for Source

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.