Struct DeprecationParams 

pub struct DeprecationParams {
    pub since: String,
    pub message: Option<String>,
    pub name: Option<String>,
    pub alternative: Option<String>,
    pub alternative_import: Option<String>,
    pub pending: bool,
    pub obj_type: Option<String>,
    pub addendum: Option<String>,
    pub removal: Option<String>,
    pub package: Option<String>,
}

Parameters for configuring deprecation warnings.

Fields

since: String

The release at which this API became deprecated.

message: Option<String>

Override the default deprecation message.

name: Option<String>

The name of the deprecated object.

alternative: Option<String>

An alternative API that the user may use in place of the deprecated API.

alternative_import: Option<String>

An alternative import path that the user may use instead.

pending: bool

If true, uses a pending deprecation warning instead.

obj_type: Option<String>

The object type being deprecated (e.g., “function”, “class”, “method”).

addendum: Option<String>

Additional text appended directly to the final message.

removal: Option<String>

The expected removal version.

package: Option<String>

The package of the deprecated object.

Implementations

impl DeprecationParams

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

Create new deprecation parameters with the version when deprecation started.

pub fn with_name(self, name: impl Into<String>) -> Self

Set the name of the deprecated item.

pub fn with_message(self, message: impl Into<String>) -> Self

Set a custom deprecation message.

pub fn with_alternative(self, alternative: impl Into<String>) -> Self

Set the alternative to use instead of the deprecated item.

pub fn with_alternative_import( self, alternative_import: impl Into<String>, ) -> Self

Set the alternative import path.

pub fn with_pending(self, pending: bool) -> Self

Mark this as a pending deprecation.

pub fn with_obj_type(self, obj_type: impl Into<String>) -> Self

Set the object type.

pub fn with_addendum(self, addendum: impl Into<String>) -> Self

Set the addendum text.

pub fn with_removal(self, removal: impl Into<String>) -> Self

Set the expected removal version.

pub fn with_package(self, package: impl Into<String>) -> Self

Set the package name.

pub fn validate(&self) -> Result<(), String>

Validate the deprecation parameters.

Returns an error if the parameters are invalid.

Trait Implementations

impl Clone for DeprecationParams

fn clone(&self) -> DeprecationParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeprecationParams

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

Formats the value using the given formatter.

impl Default for DeprecationParams

fn default() -> DeprecationParams

Returns the “default value” for a type.