Skip to main content

TimedCap

Struct TimedCap 

Source
pub struct TimedCap<P: Permission> { /* private fields */ }
Expand description

A time-bounded capability token proving the holder has permission P.

Created via TimedCap::new, which consumes a Cap<P> and a TTL duration. After the TTL elapses, try_cap() returns Err(CapSecError::Expired).

!Send + !Sync by default — use make_send for cross-thread transfer. Cloning copies the same expiry instant.

Implementations§

Source§

impl<P: Permission> TimedCap<P>

Source

pub fn new(_cap: Cap<P>, ttl: Duration) -> Self

Creates a time-bounded capability by consuming a Cap<P> as proof of possession.

The capability expires after ttl has elapsed from the moment of creation.

Source

pub fn try_cap(&self) -> Result<Cap<P>, CapSecError>

Attempts to obtain a Cap<P> from this timed capability.

Returns Ok(Cap<P>) if the TTL has not elapsed, or Err(CapSecError::Expired) if the capability has expired.

Source

pub fn is_active(&self) -> bool

Advisory check — returns true if the capability has not yet expired.

The result is immediately stale; do not use for control flow. Always use try_cap for actual access.

Source

pub fn remaining(&self) -> Duration

Returns the remaining duration before expiry.

Returns Duration::ZERO if the capability has already expired.

Source

pub fn make_send(self) -> TimedSendCap<P>

Converts this capability into a TimedSendCap that can cross thread boundaries.

This is an explicit opt-in — you’re acknowledging that this capability will be used in a multi-threaded context.

Trait Implementations§

Source§

impl<P: Permission> Clone for TimedCap<P>

Source§

fn clone(&self) -> Self

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

Auto Trait Implementations§

§

impl<P> Freeze for TimedCap<P>

§

impl<P> RefUnwindSafe for TimedCap<P>
where P: RefUnwindSafe,

§

impl<P> !Send for TimedCap<P>

§

impl<P> !Sync for TimedCap<P>

§

impl<P> Unpin for TimedCap<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for TimedCap<P>

§

impl<P> UnwindSafe for TimedCap<P>
where P: 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.