Struct DeprecatedWarningBuilder

pub struct DeprecatedWarningBuilder { /* private fields */ }

Gradually build a deprecation Warning.

Example

use proc_macro_warning::Warning;

let warning = Warning::new_deprecated("my_macro")
    .old("my_macro()")
    .new("my_macro::new()")
    .help_link("https:://example.com")
    // Normally you use the input span, but this is an example:
    .span(proc_macro2::Span::call_site())
    .build_or_panic();

let mut warnings = vec![warning];
// When adding more, you will need to build each with `.index`.

// In a proc macro you can expand them in a private module:
quote::quote! {
    mod warnings {
        #(
            #warnings
        )*
    }
};

Implementations

impl DeprecatedWarningBuilder

pub fn from_title<S: Into<String>>(title: S) -> Self

Create a new deprecated warning builder with the given title.

The title must be unique for each warning.

pub fn index<S: Into<usize>>(self, index: S) -> Self

Set an optional index in case that a warning appears multiple times.

Must be set if a warning appears multiple times.

pub fn old<S: Into<String>>(self, old: S) -> Self

The old deprecated way of doing something.

Should complete the sentence “It is deprecated to …”.

pub fn new<S: Into<String>>(self, new: S) -> Self

The new way of doing something.

Should complete the sentence “Please instead …”.

pub fn help_link<S: Into<String>>(self, link: S) -> Self

A help link for the user to explain the transition and justification.

pub fn help_links(self, links: &[&str]) -> Self

Multiple help links for the user to explain the transition and justification.

pub fn span(self, span: Span) -> Self

Set the span of the warning.

pub fn maybe_build(self) -> Result<Warning, String>

👎Deprecated: Use try_build instead; Will be removed after Q1 2024

Fallibly build a warning.

pub fn try_build(self) -> Result<Warning, String>

Try to build the warning.

pub fn build(self) -> Warning

👎Deprecated: Use build_or_panic instead; Will be removed after Q1 2024

Unwraps Self::maybe_build for convenience.

pub fn build_or_panic(self) -> Warning

Build the warning or panic if it fails.

Trait Implementations

impl Clone for DeprecatedWarningBuilder

fn clone(&self) -> DeprecatedWarningBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeprecatedWarningBuilder

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

Formats the value using the given formatter.

impl Default for DeprecatedWarningBuilder

fn default() -> DeprecatedWarningBuilder

Returns the “default value” for a type.