Enum DeprecationStatus

pub enum DeprecationStatus {
    Current,
    Deprecated(Option<String>),
}

Whether an item is deprecated, with context.

Variants

Current

The field/variant is not deprecated.

Deprecated(Option<String>)

The field/variant is deprecated, with an optional reason

Implementations

impl DeprecationStatus

pub fn is_deprecated(&self) -> bool

If this deprecation status indicates the item is deprecated.

pub fn reason(&self) -> Option<&str>

An optional reason for the deprecation, or none if Current.

Trait Implementations

impl Clone for DeprecationStatus

fn clone(&self) -> DeprecationStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeprecationStatus

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

Formats the value using the given formatter.

impl Hash for DeprecationStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DeprecationStatus

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

impl StructuralPartialEq for DeprecationStatus