Struct SourceFileRef

pub struct SourceFileRef { /* private fields */ }

A reference to a specific spanned region of a SourceFile, that provides access to the actual SourceFile, but scoped to the span it was created with.

This is useful in error types that implement miette::Diagnostic, as it contains all of the data necessary to render the source code being referenced, without a super::SourceManager on hand.

Implementations

impl SourceFileRef

pub fn new(file: Arc<SourceFile>, span: impl Into<Range<u32>>) -> SourceFileRef

Create a SourceFileRef from a SourceFile and desired span (in bytes)

The given span will be constrained to the bytes of file, so a span that reaches out of bounds will have its end bound set to the last byte of the file.

pub fn source_file(&self) -> Arc<SourceFile>

Returns a ref-counted handle to the underlying SourceFile

pub fn path(&self) -> &Path

Returns the name of the file this SourceFileRef is selecting, as a std::path::Path

pub fn name(&self) -> &str

Returns the name of the file this SourceFileRef is selecting

pub const fn span(&self) -> SourceSpan

Returns the SourceSpan selected by this SourceFileRef

pub fn as_str(&self) -> &str

Returns the underlying str selected by this SourceFileRef

pub fn as_bytes(&self) -> &[u8]

Returns the underlying bytes selected by this SourceFileRef

pub fn len(&self) -> usize

Returns the number of bytes represented by the subset of the underlying file that is covered by this SourceFileRef

pub fn is_empty(&self) -> bool

Returns true if this selection is empty

Trait Implementations

impl AsRef<[u8]> for SourceFileRef

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for SourceFileRef

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SourceFileRef

fn clone(&self) -> SourceFileRef

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SourceFileRef

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

Formats the value using the given formatter.

impl From<&SourceFileRef> for SourceSpan

fn from(source: &SourceFileRef) -> SourceSpan

Converts to this type from the input type.

impl Hash for SourceFileRef

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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.

impl Ord for SourceFileRef

fn cmp(&self, other: &SourceFileRef) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SourceFileRef

fn eq(&self, other: &SourceFileRef) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SourceFileRef

fn partial_cmp(&self, other: &SourceFileRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SourceCode for SourceFileRef

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

Read the bytes for a specific span from this SourceCode, keeping a certain number of lines before and after the span as context.

impl Eq for SourceFileRef