Expirable

Struct Expirable 

Source
pub struct Expirable { /* private fields */ }
Expand description

A container for TTL-wrapped values.

Expirable is one of the six container types. It wraps a child node with expiration metadata, producing { value, expires_at, created_at }.

§Example

use paramdef::container::Expirable;
use paramdef::types::leaf::Text;

let token = Expirable::builder("cached_token")
    .label("Cached Token")
    .ttl_hours(1)
    .auto_refresh(true)
    .warning_threshold(300) // Warn 5 min before expiry
    .child(Text::builder("token").build())
    .build();

Implementations§

Source§

impl Expirable

Source

pub fn builder(key: impl Into<Key>) -> ExpirableBuilder

Creates a new builder for an Expirable container.

Source

pub fn flags(&self) -> Flags

Returns the flags for this expirable.

Source

pub fn child(&self) -> Option<&Arc<dyn Node>>

Returns the child node, if any.

Source

pub fn options(&self) -> &ExpirableOptions

Returns the expirable options.

Source

pub fn ttl(&self) -> u64

Returns the TTL in seconds.

Trait Implementations§

Source§

impl Clone for Expirable

Source§

fn clone(&self) -> Expirable

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Container for Expirable

Source§

fn children(&self) -> &[Arc<dyn Node>]

Returns all child nodes.
Source§

impl Debug for Expirable

Source§

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

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

impl Node for Expirable

Source§

fn metadata(&self) -> &Metadata

Returns the node’s metadata.
Source§

fn key(&self) -> &Key

Returns the node’s unique key.
Source§

fn kind(&self) -> NodeKind

Returns the node’s kind (category).
Source§

fn as_any(&self) -> &dyn Any

Returns a reference to the underlying type for downcasting.
Source§

fn as_any_mut(&mut self) -> &mut dyn Any

Returns a mutable reference to the underlying type for downcasting.

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> 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.