Value

Struct Value 

Source
pub struct Value<V, TS> { /* private fields */ }
Expand description

Wraps a map value with a specified expiry TimeSource.

Implementations§

Source§

impl<V, TS> Value<V, TS>
where V: Clone, TS: TimeSource,

Source

pub fn new(value: V, lifetime: Duration) -> Self

Creates a new Value with the given inner value and lifetime as Duration.

The values expiry is calculated by adding the specified lifetime to the result of TS:now().

Source

pub fn is_expired(&self) -> bool

Returns true when the specified expiry is after the current time.

Source

pub fn is_expired_at(&self, at: &TS) -> bool

Returns true when the specified expiry is after the given time at.

Source

pub fn expires(&self) -> &TS

Returns a reference to the values expiry TimeSource.

Source

pub fn set_expiry(&mut self, lifetime: Duration)

Sets the expiry of the value to now plus the given lifetime.

Source

pub fn add_expiry(&mut self, lifetime: Duration)

Adds the given duration to the values expiry.

Source

pub fn value(&self) -> V

Returns a copy of the inner value.

Source

pub fn value_ref(&self) -> &V

Returns a reference to the inner value.

Source

pub fn value_checked(&self) -> Option<V>

Returns a copy of the inner value if the expiry has not yet exceeded.

Source

pub fn value_ref_checked(&self) -> Option<&V>

Returns a reference to the inner value if the expiry has not yet exceeded.

Trait Implementations§

Source§

impl<V: Clone, TS: Clone> Clone for Value<V, TS>

Source§

fn clone(&self) -> Value<V, TS>

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<V: Debug, TS: Debug> Debug for Value<V, TS>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<V, TS> Freeze for Value<V, TS>
where V: Freeze, TS: Freeze,

§

impl<V, TS> RefUnwindSafe for Value<V, TS>

§

impl<V, TS> Send for Value<V, TS>
where V: Send, TS: Send,

§

impl<V, TS> Sync for Value<V, TS>
where V: Sync, TS: Sync,

§

impl<V, TS> Unpin for Value<V, TS>
where V: Unpin, TS: Unpin,

§

impl<V, TS> UnwindSafe for Value<V, TS>
where V: UnwindSafe, TS: UnwindSafe,

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.