Struct Diagnostic 

pub struct Diagnostic {
    pub severity: Severity,
    pub code: String,
    pub path: Option<String>,
    pub message: String,
}

One finding about the declarative state, named by a stable code, tied to a path where there is one, and carrying the command that reproduces it where there is one.

Fields

severity: Severity

How bad.

code: String

A stable machine-readable code, e.g. unknown_key, duplicate_identity.

path: Option<String>

Repository-relative path of the file concerned, when there is one.

message: String

What is wrong, for a person; the code is for a program.

Implementations

impl Diagnostic

pub fn error( code: &'static str, path: Option<String>, message: impl Into<String>, ) -> Self

An error diagnostic.

use majordomus_cli::{Diagnostic, Severity};
let d = Diagnostic::error("unknown_key", Some("docs/x.md".into()), "key(s) not in schema 'rule': owner");
assert_eq!(d.severity, Severity::Error);
assert_eq!(d.code, "unknown_key");

pub fn warning( code: &'static str, path: Option<String>, message: impl Into<String>, ) -> Self

A warning diagnostic.

pub fn info( code: &'static str, path: Option<String>, message: impl Into<String>, ) -> Self

An informational diagnostic.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Diagnostic

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Diagnostic

impl JsonSchema for Diagnostic

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Diagnostic

fn eq(&self, other: &Diagnostic) -> 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 Serialize for Diagnostic

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Diagnostic