Struct Source 

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

A Typst source file containing the full source text, a mapping from byte indices to lines/columns, and the parsed syntax tree.

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 with_root(id: FileId, text: String, root: SyntaxNode) -> Self

Create a new source file with an already created syntax tree.

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 lines(&self) -> &Lines<String>

An acceleration structure for conversion of UTF-8, UTF-16 and line/column indices.

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 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, num: SpanNumber, sub_range: Option<SubRange>, ) -> Option<Range<usize>>

Get the byte range for the given span number (and optional sub-range) in this file.

The main way to get a SpanNumber is by unpacking a span with Span::get, but it’s likely easier to use WorldExt::range instead.

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