Struct rune::Source

pub struct Source { /* fields omitted */ }

A single source file.

Implementations

impl Source

pub fn emit_source_line<O>(&self, out: &mut O, span: Span) -> Result<()> where
    O: WriteColor, 

This is supported on crate feature emit only.

Print formatted diagnostics about a source conveniently.

impl Source

pub fn new(name: impl AsRef<str>, source: impl AsRef<str>) -> Self

Construct a new source with the given name.

pub fn from_path(path: &Path) -> Result<Self>

Read and load a source from the given path.

pub fn with_path(
    name: impl AsRef<str>,
    source: impl AsRef<str>,
    path: Option<impl AsRef<Path>>
) -> Self

Construct a new source with the given name.

pub fn line_starts(&self) -> &[usize]

Access all line starts in the source.

pub fn is_empty(&self) -> bool

Test if the source is empty.

pub fn len(&self) -> usize

Get the length of the source.

pub fn name(&self) -> &str

Get the name of the source.

pub fn get<I>(&self, i: I) -> Option<&I::Output> where
    I: SliceIndex<str>, 

et the given range from the source.

pub fn as_str(&self) -> &str

Access the underlying string for the source.

pub fn path(&self) -> Option<&Path>

Get the (optional) path of the source.

pub fn position_to_utf16cu_line_char(
    &self,
    offset: usize
) -> Option<(usize, usize)>

Convert the given offset to a utf-16 line and character.

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

Convert the given offset to a utf-16 line and character.

pub fn line_index(&self, byte_index: usize) -> usize

Get the line index for the given byte.

pub fn line_range(&self, line_index: usize) -> Option<Range<usize>>

Get the range corresponding to the given line index.

pub fn line_count(&self) -> usize

Get the number of lines in the source.

pub fn line(&self, span: Span) -> Option<(usize, usize, &str)>

Access the line number of content that starts with the given span.

Trait Implementations

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 Default for Source

fn default() -> Source

Returns the “default value” for a type.