Struct Report 

#[non_exhaustive]
pub struct Report<'a> {
    pub type: ReportType,
    pub id: Option<Cow<'a, str>>,
    pub title: Cow<'a, str>,
    pub snippets: Vec<Snippet<'a>>,
    pub footnotes: Vec<Footnote<'a>>,
}

Entire report containing multiple snippets

Report is an intermediate data structure for constructing a diagnostic message. It contains multiple Snippets, each of which corresponds to a specific part of the source code being analyzed. See the module documentation for more details.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: ReportType

Type of this report

id: Option<Cow<'a, str>>

Optional identifier of this report (e.g., error code)

title: Cow<'a, str>

Main caption of this report

snippets: Vec<Snippet<'a>>

Source code fragments annotated with additional information

footnotes: Vec<Footnote<'a>>

Additional message without associated source code

Implementations

impl Report<'_>

pub fn new() -> Self

Creates a new, empty report.

Trait Implementations

impl<'a> Clone for Report<'a>

fn clone(&self) -> Report<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Report<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Report<'a>

fn default() -> Report<'a>

Returns the “default value” for a type.

impl<'a> From<&'a Report<'a>> for Group<'a>

Converts yash_env::source::pretty::Report into annotate_snippets::Group.

fn from(report: &'a Report<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a StartSubshellError> for Report<'a>

fn from(error: &'a StartSubshellError) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Report<'a>

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

impl<'a> StructuralPartialEq for Report<'a>