Struct Snippet 

pub struct Snippet<'a> {
    pub code: &'a Code,
    pub spans: Vec<Span<'a>>,
    /* private fields */
}

Fragment of source code with annotated spans highlighting specific regions

A snippet corresponds to a single source Code. It contains zero or more Spans that annotate specific parts of the code.

Snippet holds a Ref to the string held in self.code.value, which provides an access to the string without making a new borrow (code_string). This allows creating another message builder such as annotate_snippets::Snippet without the need to retain a borrow of self.code.value.

Fields

code: &'a Code

Source code to which the spans refer

spans: Vec<Span<'a>>

Spans describing parts of the code

Implementations

impl Snippet<'_>

pub fn with_code(code: &Code) -> Snippet<'_>

Creates a new snippet for the given code without any spans.

pub fn with_code_and_spans<'a>( code: &'a Code, spans: Vec<Span<'a>>, ) -> Snippet<'a>

Creates a new snippet for the given code with the given spans.

pub fn with_primary_span<'a>( location: &'a Location, label: Cow<'a, str>, ) -> Vec<Snippet<'a>>

Creates a vector containing a snippet with a primary span.

This is a convenience function for creating a vector of snippets containing a primary span created from the given location and label. The returned vector can be used as the snippets field of a Report.

This function calls Source::extend_with_context for location.code.source, thereby adding supplementary spans describing the context of the source code. This means that the returned vector may contain multiple snippets or spans if the source has a related location.

pub fn code_string(&self) -> &str

Returns the string held in self.code.value.

This method returns a reference to the string held in self.code.value. Snippet internally holds a Ref to the string, which provides an access to the string without making a new borrow.

Trait Implementations

impl Clone for Snippet<'_>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Snippet<'a>

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

Formats the value using the given formatter.

impl PartialEq<Snippet<'_>> for Snippet<'_>

fn eq(&self, other: &Snippet<'_>) -> 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 Eq for Snippet<'_>