Struct Issue 

#[non_exhaustive]
pub struct Issue {
    pub code: IssueCode,
    pub severity: Severity,
    pub path: AuthoredPath,
    pub step_kind: Option<StepKind>,
    pub step_id: Option<String>,
    pub field: Option<String>,
    pub message: String,
}

One finding about an authored definition.

It serializes as an object of its seven fields, under their own names: the code and severity as their strings, the path as it displays, the step kind as task, group or setup, and an absent part as null.

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.

code: IssueCode

What it is about.

severity: Severity

When it bites: its code’s own severity, unless the host overrode it.

path: AuthoredPath

Where in the authored JSON.

step_kind: Option<StepKind>

The kind of step it sits in, if any.

step_id: Option<String>

The id of the step it sits in, if known.

field: Option<String>

The config field (the first key under function.input), if inside one.

message: String

A human-readable explanation.

Implementations

impl Issue

pub fn new( code: IssueCode, path: AuthoredPath, message: impl Into<String>, ) -> Self

An issue at its code’s default severity.

pub fn with_severity(self, severity: Severity) -> Self

Overrides the severity.

pub fn with_step(self, kind: StepKind, id: Option<&str>) -> Self

Names the step the issue sits in.

pub fn with_field(self, field: impl Into<String>) -> Self

Names the config field the issue sits in.

Trait Implementations

impl Clone for Issue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Issue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Issue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Issue

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

Formats the value using the given formatter.

impl Eq for Issue

impl PartialEq for Issue

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Issue

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 Issue