Skip to main content

EffectDescriptor

Struct EffectDescriptor 

Source
pub struct EffectDescriptor {
    pub id: Symbol,
    pub shape: Symbol,
    pub capability: CapabilityName,
    pub bounds: EffectBounds,
    pub requires_arm: bool,
    pub expires_after: Duration,
    pub receipt: Symbol,
    pub idempotence: IdempotencePolicy,
    pub reversal: ReversalPolicy,
    pub local_stop: Symbol,
}
Expand description

Complete registered authority description for one named effect.

Fields§

§id: Symbol

Stable descriptor identity.

§shape: Symbol

Shape reference used to validate the request payload.

§capability: CapabilityName

Capability required from the caller.

§bounds: EffectBounds

Request and session bounds.

§requires_arm: bool

Whether an explicit arm token is mandatory.

§expires_after: Duration

Maximum age of an armed request.

§receipt: Symbol

Receipt kind emitted after execution.

§idempotence: IdempotencePolicy

Retry semantics.

§reversal: ReversalPolicy

Reversal semantics.

§local_stop: Symbol

Locally executable stop effect.

Implementations§

Source§

impl EffectDescriptor

Source

pub fn validate(&self) -> DeviceResult<()>

Validates that every mandatory authority field is meaningful.

Source

pub fn authorize(&self, request: &EffectRequest) -> DeviceResult<()>

Checks caller authority, arming, expiry, idempotence, and payload bounds.

Trait Implementations§

Source§

impl Clone for EffectDescriptor

Source§

fn clone(&self) -> EffectDescriptor

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 EffectDescriptor

Source§

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

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

impl Eq for EffectDescriptor

Source§

impl PartialEq for EffectDescriptor

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EffectDescriptor

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.