Struct Warning 

#[non_exhaustive]
pub struct Warning {
    pub message: String,
    pub origin: Option<Origin>,
    pub kind: WarningKind,
}

Something a user should know about, which is not bad enough to stop for.

Returned rather than printed. mise queues these until its logging is up, and a library that writes to stderr on its own cannot be used by anything that has an opinion about output.

Built through Warning::new or Warning::at rather than as a literal: this has gained a field once already, and a warning is something a layer reports rather than a shape anything downstream should be pattern-matched against exhaustively. Reading the fields, and matching with .., are unaffected.

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.

message: String

origin: Option<Origin>

Where the value that caused it came from, when there was one.

kind: WarningKind

What sort of thing happened, for a caller that wants to treat them differently.

Implementations

impl Warning

pub fn new(message: impl Into<String>) -> Self

A warning of no particular kind, which is what a custom layer’s own complaints are.

pub fn at(message: impl Into<String>, origin: Origin) -> Self

The same, about a value that came from somewhere nameable.

pub fn of(self, kind: WarningKind) -> Self

This warning, classified.

Chained rather than an argument so the two constructors keep reading as they did, and so a layer that has nothing useful to say about the kind is not made to invent one.

Trait Implementations

impl Clone for Warning

fn clone(&self) -> Warning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Warning

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

Formats the value using the given formatter.

impl PartialEq for Warning

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Warning