Trait miette::Source

pub trait Source: Debug + Send + Sync {
    fn read_span<'a>(
        &'a self, 
        span: &SourceSpan
    ) -> Result<Box<dyn SpanContents + 'a>, MietteError>;
}

Represents a readable source of some sort.

This trait is able to support simple Source types like Strings, as well as more involved types like indexes into centralized SourceMap-like types, file handles, and even network streams.

If you can read it, you can source it, and it’s not necessary to read the whole thing–meaning you should be able to support Sources which are gigabytes or larger in size.

Required methods

fn read_span<'a>(
    &'a self,
    span: &SourceSpan
) -> Result<Box<dyn SpanContents + 'a>, MietteError>

Read the bytes for a specific span from this Source.

Implementations on Foreign Types

impl Source for String

fn read_span(
    &self,
    span: &SourceSpan
) -> Result<Box<dyn SpanContents>, MietteError>

impl<T: Source> Source for Arc<T>

fn read_span<'a>(
    &'a self,
    span: &SourceSpan
) -> Result<Box<dyn SpanContents + 'a>, MietteError>

impl<T: Source + Clone> Source for Cow<'_, T>

fn read_span<'a>(
    &'a self,
    span: &SourceSpan
) -> Result<Box<dyn SpanContents + 'a>, MietteError>

Implementors