Struct rune::Sources

pub struct Sources { /* private fields */ }

A collection of source files.

Implementations

impl Sources

pub fn new() -> Self

Construct a new collection of sources.

pub fn insert(&mut self, source: Source) -> Result<SourceId>

Insert a source and return its SourceId.

Examples

use rune::{Sources, Source};

let mut sources = Sources::new();
let id = sources.insert(Source::new("<memory>", "pub fn main() { 10 }")?)?;
let id2 = sources.insert(Source::new("<memory>", "pub fn main() { 10 }")?)?;
assert_ne!(id, id2);

pub fn get(&self, id: SourceId) -> Option<&Source>

Get the source matching the given source id.

Examples

use rune::{Sources, Source};

let mut sources = Sources::new();
let id = sources.insert(Source::new("<memory>", "pub fn main() { 10 }")?)?;

let source = sources.get(id).context("expected source")?;

assert_eq!(source.name(), "<memory>");

Trait Implementations

impl Debug for Sources

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

Formats the value using the given formatter.

impl Default for Sources

fn default() -> Sources

Returns the “default value” for a type.

impl<'a> Files<'a> for Sources

type FileId = SourceId

A unique identifier for files in the file provider. This will be used for rendering diagnostic::Labels in the corresponding source files.

type Name = &'a str

The user-facing name of a file, to be displayed in diagnostics.

type Source = &'a str

The source code of a file.

fn name(&'a self, file_id: SourceId) -> Result<Self::Name, Error>

The user-facing name of a file.

fn source(&'a self, file_id: SourceId) -> Result<Self::Source, Error>

The source code of a file.

fn line_index( &self, file_id: SourceId, byte_index: usize ) -> Result<usize, Error>

The index of the line at the given byte index. If the byte index is past the end of the file, returns the maximum line index in the file. This means that this function only fails if the file is not present.

fn line_range( &self, file_id: SourceId, line_index: usize ) -> Result<Range<usize>, Error>

The byte range of line in the source of the file.

fn line_number( &'a self, id: Self::FileId, line_index: usize ) -> Result<usize, Error>

The user-facing line number at the given line index. It is not necessarily checked that the specified line index is actually in the file.

fn column_number( &'a self, id: Self::FileId, line_index: usize, byte_index: usize ) -> Result<usize, Error>

The user-facing column number at the given line index and byte index.

fn location( &'a self, id: Self::FileId, byte_index: usize ) -> Result<Location, Error>

Convenience method for returning line and column number at the given byte index in the file.