Struct rune::Source

pub struct Source { /* private fields */ }

A single source file.

Implementations

impl Source

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

where O: WriteColor,

Available 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>) -> Result<Self>

Construct a new source with the given name.

pub fn memory(source: impl AsRef<str>) -> Result<Self>

Construct a new anonymously named <memory> source.

Examples

use rune::Source;

let source = Source::memory("pub fn main() { 42 }")?;
assert_eq!(source.name(), "<memory>");

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, FromPathError>

Available on crate feature std only.

Read and load a source from the given filesystem path.

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

Construct a new source with the given content and path.

Examples

use std::path::Path;
use rune::Source;

let source = Source::with_path("test", "pub fn main() { 42 }", "test.rn")?;
assert_eq!(source.name(), "test");
assert_eq!(source.path(), Some(Path::new("test.rn")));

pub fn name(&self) -> &str

Get the name of the source.

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

Get the path associated with the source.

Examples

use std::path::Path;
use rune::Source;

let source = Source::with_path("test", "pub fn main() { 42 }", "test.rn")?;
assert_eq!(source.name(), "test");
assert_eq!(source.path(), Some(Path::new("test.rn")));

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

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

Trait Implementations

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.

impl TryClone for Source

fn try_clone(&self) -> Result<Self>

Try to clone the current value, raising an allocation error if it’s unsuccessful.

fn try_clone_from(&mut self, source: &Self) -> Result<(), Error>

Performs copy-assignment from source.