Struct Annotation 

pub struct Annotation {
    pub path: Vec<Seg>,
    pub severity: Severity,
    pub message: String,
}

One host finding, addressed at a node by the same path everything else here is addressed by.

The path need not name a row that exists. A finding about a key the document has since lost is simply never matched — dropping it would make the host responsible for pruning its own list against a tree it does not own.

Fields

path: Vec<Seg>

The fig path of the node this is about. The empty path is the document.

severity: Severity

message: String

One line, written for the person looking at the row. A renderer with a status bar shows it there; one with room shows it under the row.

Implementations

impl Annotation

pub fn new( path: Vec<Seg>, severity: Severity, message: impl Into<String>, ) -> Self

A finding at path.

pub fn error(path: Vec<Seg>, message: impl Into<String>) -> Self

Shorthand for an Severity::Error at path.

pub fn warning(path: Vec<Seg>, message: impl Into<String>) -> Self

Shorthand for a Severity::Warning at path.

pub fn info(path: Vec<Seg>, message: impl Into<String>) -> Self

Shorthand for an Severity::Info at path.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl Eq for Annotation

impl PartialEq for Annotation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Annotation