Struct NamedSource

pub struct NamedSource<S: SourceCode + 'static> { /* private fields */ }

Utility struct for when you have a regular SourceCode type that doesn’t implement name. For example String. Or if you want to override the name returned by the SourceCode.

Implementations

impl<S: SourceCode + 'static> NamedSource<S>

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

where S: Send + Sync,

Create a new NamedSource using a regular SourceCode and giving its returned SpanContents a name.

pub fn name(&self) -> &str

Gets the name of this NamedSource.

pub fn inner(&self) -> &S

Returns a reference the inner SourceCode type for this NamedSource.

pub fn with_language(self, language: impl Into<String>) -> Self

Sets the language for this source code.

Trait Implementations

impl<S: Clone + SourceCode + 'static> Clone for NamedSource<S>

fn clone(&self) -> NamedSource<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: SourceCode> Debug for NamedSource<S>

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

Formats the value using the given formatter.

impl<S: Hash + SourceCode + 'static> Hash for NamedSource<S>

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

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<S: Ord + SourceCode + 'static> Ord for NamedSource<S>

fn cmp(&self, other: &NamedSource<S>) -> 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<S: PartialEq + SourceCode + 'static> PartialEq for NamedSource<S>

fn eq(&self, other: &NamedSource<S>) -> 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<S: PartialOrd + SourceCode + 'static> PartialOrd for NamedSource<S>

fn partial_cmp(&self, other: &NamedSource<S>) -> 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<S: SourceCode + 'static> SourceCode for NamedSource<S>

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<S: Eq + SourceCode + 'static> Eq for NamedSource<S>

impl<S: SourceCode + 'static> StructuralPartialEq for NamedSource<S>