Enum LifecycleStage 

pub enum LifecycleStage {
    Experimental,
    Stable,
    Superseded,
    SoftDeprecated,
    Deprecated,
    Defunct,
}

Lifecycle stage for a function, method, or argument.

Variants

Experimental

Function is experimental and may change.

Stable

Function is stable (no badge/warning needed).

Superseded

Function has a better alternative but will be maintained.

SoftDeprecated

Function should no longer be used (soft warning first).

Deprecated

Function should no longer be used (warning).

Defunct

Function no longer works (error).

Implementations

impl LifecycleStage

pub fn from_str(s: &str) -> Option<Self>

Parse a lifecycle stage from a string.

Accepts lowercase stage names. Both "soft-deprecated" and "soft_deprecated" are recognized. Returns None for unrecognized strings.

pub fn badge(&self) -> Option<&'static str>

Get the inline R roxygen expression for the lifecycle badge.

Returns an R inline code expression like `r lifecycle::badge("experimental")` that roxygen2 evaluates to render a colored badge. Returns None for Stable (no badge needed).

pub fn signal_fn(&self) -> Option<&'static str>

Get the fully-qualified lifecycle signal function name.

Returns the R function to call at the start of the wrapper body to emit the lifecycle signal (e.g., "lifecycle::deprecate_warn"). Returns None for Stable (no signal needed).

pub fn import_from_fn(&self) -> Option<&'static str>

Get the bare R function name for @importFrom lifecycle roxygen tag.

Returns the function name without the lifecycle:: prefix.

pub fn keywords(&self) -> Option<&'static str>

Get the roxygen @keywords value, if this stage needs one.

Only Experimental adds @keywords internal to keep the function off the main package index. Returns None for all other stages.

Trait Implementations

impl Clone for LifecycleStage

fn clone(&self) -> LifecycleStage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LifecycleStage

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

Formats the value using the given formatter.

impl Default for LifecycleStage

fn default() -> LifecycleStage

Returns the “default value” for a type.

impl Display for LifecycleStage

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

Formats the value using the given formatter.

impl Eq for LifecycleStage

#[doc(hidden)]

fn assert_fields_are_eq(&self)

🔬This is a nightly-only experimental API. (derive_eq_internals)

#[doc(hidden)]

fn assert_receiver_is_total_eq(&self)

👎Deprecated since 1.95.0:

implementation detail of #[derive(Eq)]

impl PartialEq for LifecycleStage

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

impl StructuralPartialEq for LifecycleStage

impl TrivialClone for LifecycleStage

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte

Size for each variant:

• Experimental: 0 bytes
• Stable: 0 bytes
• Superseded: 0 bytes
• SoftDeprecated: 0 bytes
• Deprecated: 0 bytes
• Defunct: 0 bytes