Struct Warning 

pub struct Warning {
    pub kind: WarningKind,
    pub name: String,
    pub message: Option<String>,
    pub warn_at: Option<String>,
    pub remove_at: Option<String>,
    pub replacement: Option<String>,
}

One thing a command line used that its own spec says not to use any more.

Fields

kind: WarningKind

What sort of declaration it was, for a caller that treats them differently.

name: String

What the user typed or set: --old-flag, old-cmd, OLD_ENV.

message: Option<String>

The author’s reason, when the declaration carries one.

warn_at: Option<String>

The release warnings start at. A warning that is here has already passed it.

remove_at: Option<String>

The release the declaration goes away in, when the author has named one.

replacement: Option<String>

What to use instead, when the declaration implies one.

Implementations

impl Warning

pub fn flag( name: impl Into<String>, message: Option<String>, warn_at: Option<String>, remove_at: Option<String>, ) -> Self

A deprecated flag that was given, named as the user names it.

pub fn command( name: impl Into<String>, message: Option<String>, warn_at: Option<String>, remove_at: Option<String>, ) -> Self

A deprecated command that was selected.

pub fn env(name: impl Into<String>, replacement: Option<String>) -> Self

A value read from a deprecated environment alias, and the current name for it.

pub fn render(&self) -> String

What a caller should print for this warning.

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 Eq for Warning

impl PartialEq for Warning

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Warning