Skip to main content

CaveatPredicate

Enum CaveatPredicate 

Source
pub enum CaveatPredicate {
    TimeBefore(u64),
    TimeAfter(u64),
    RegionScope(u64),
    TaskScope(u64),
    MaxUses(u32),
    ResourceScope(String),
    RateLimit {
        max_count: u32,
        window_secs: u32,
    },
    Custom(String, String),
}
Expand description

A predicate that restricts when/where a capability token is valid.

Caveats form a conjunction: all must be satisfied for the token to be valid. New caveats can only narrow (never widen) access.

Variants§

§

TimeBefore(u64)

Token is valid only before this virtual timestamp (milliseconds).

§

TimeAfter(u64)

Token is valid only after this virtual timestamp (milliseconds).

§

RegionScope(u64)

Token is scoped to a specific region ID.

§

TaskScope(u64)

Token is scoped to a specific task ID.

§

MaxUses(u32)

Maximum number of times the token may be checked.

§

ResourceScope(String)

Token is scoped to resources matching a glob pattern.

The pattern uses simple glob syntax: * matches any segment, ** matches any number of segments, exact segments match literally.

§

RateLimit

Windowed rate limit: at most max_count uses per window_secs seconds.

Checked against VerificationContext::window_use_count. The caller is responsible for tracking the sliding window externally.

Fields

§max_count: u32

Maximum invocations allowed in the window.

§window_secs: u32

Window duration in seconds (encoded for the caveat chain, checked externally).

§

Custom(String, String)

Custom key-value predicate for extensibility.

Implementations§

Source§

impl CaveatPredicate

Source

pub fn to_bytes(&self) -> Vec<u8>

Encode the predicate to bytes for HMAC chaining.

Source

pub fn from_bytes(data: &[u8]) -> Option<(Self, usize)>

Decode a predicate from bytes. Returns the predicate and bytes consumed.

§Errors

Returns None if the bytes are malformed.

Source

pub fn display_string(&self) -> String

Human-readable summary of this predicate.

Trait Implementations§

Source§

impl Clone for CaveatPredicate

Source§

fn clone(&self) -> CaveatPredicate

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 Debug for CaveatPredicate

Source§

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

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

impl Display for CaveatPredicate

Source§

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

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

impl PartialEq for CaveatPredicate

Source§

fn eq(&self, other: &CaveatPredicate) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for CaveatPredicate

Source§

impl StructuralPartialEq for CaveatPredicate

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> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more