Skip to main content

LifecycleSpec

Struct LifecycleSpec 

Source
pub struct LifecycleSpec {
    pub stage: LifecycleStage,
    pub when: Option<String>,
    pub what: Option<String>,
    pub with: Option<String>,
    pub details: Option<String>,
    pub id: Option<String>,
}
Expand description

Full lifecycle specification for a function or method.

Fields§

§stage: LifecycleStage

The lifecycle stage.

§when: Option<String>

Version when the lifecycle change occurred (e.g., “0.4.0”).

§what: Option<String>

What is being deprecated (e.g., “old_fn()” or “old_fn(arg)”). Auto-inferred from function name if not provided.

§with: Option<String>

Replacement to suggest (e.g., “new_fn()”).

§details: Option<String>

Additional details message.

§id: Option<String>

Unique ID for lifecycle deprecation tracking.

Implementations§

Source§

impl LifecycleSpec

Source

pub fn new(stage: LifecycleStage) -> Self

Create a new lifecycle spec with the given stage and no additional metadata.

Source

pub fn from_deprecated(since: Option<&str>, note: Option<&str>) -> Self

Create a lifecycle spec from a Rust #[deprecated] attribute.

Maps the since field to when and attempts to parse the note field for a “use X instead” pattern to populate with. The full note is also stored in details.

Source

pub fn r_prelude(&self, fn_name: &str) -> Option<String>

Generate the R prelude code for lifecycle signaling.

Returns a single line of R code to insert at the start of the function body, or None for Stable stage. The fn_name is used as the what argument if no explicit what was provided.

For experimental/superseded: lifecycle::signal_stage("stage", "fn_name()"). For deprecated variants: lifecycle::deprecate_*(when, what, with, details, id).

Trait Implementations§

Source§

impl Clone for LifecycleSpec

Source§

fn clone(&self) -> LifecycleSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LifecycleSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LifecycleSpec

Source§

fn default() -> LifecycleSpec

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> SizedTypeProperties for T

Source§

#[doc(hidden)]
const SIZE: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGNMENT: Alignment = _

🔬This is a nightly-only experimental API. (ptr_alignment_type)
Source§

#[doc(hidden)]
const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)]
const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const MAX_SLICE_LEN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
The largest safe length for a [Self]. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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: 128 bytes