Struct Effect 

pub struct Effect {
    pub id: Ref,
    pub kind: Symbol,
    pub subject: Ref,
    pub input: Ref,
    pub result_shape: Ref,
    pub resume_op: OpKey,
    pub abort_op: OpKey,
    pub requires: Vec<CapabilityName>,
    pub replay_key: Option<ContentId>,
}

A capability-gated request resolved by an effect handler.

Fields

id: Ref

Fresh handle identifying this effect occurrence.

kind: Symbol

Symbol naming the effect kind.

subject: Ref

Reference to the effect’s subject.

input: Ref

Reference to the effect’s input.

result_shape: Ref

Shape the effect result must satisfy.

resume_op: OpKey

Operation key used to resume the effect.

abort_op: OpKey

Operation key used to abort the effect.

requires: Vec<CapabilityName>

Capabilities the caller must hold for the effect to run.

replay_key: Option<ContentId>

Content-addressed replay key, once computed.

Implementations

impl Effect

pub fn new( kind: Symbol, subject: Ref, input: Ref, result_shape: Ref, resume_op: OpKey, abort_op: OpKey, ) -> Self

Build an effect with a fresh handle id and no requirements.

pub fn with_id(self, id: Ref) -> Self

Override the effect’s id.

pub fn requiring(self, capability: CapabilityName) -> Self

Add one required capability to the effect.

pub fn with_requirements(self, requires: Vec<CapabilityName>) -> Self

Replace the effect’s required capabilities.

pub fn with_replay_key(self, implementation: Option<Ref>) -> Result<Self>

Compute and attach the replay key for the given implementation.

pub fn ensure_replay_key( &mut self, implementation: Option<Ref>, ) -> Result<ContentId>

Return the replay key, computing and caching it if absent.

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Effect

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

Formats the value using the given formatter.

impl Eq for Effect

impl PartialEq for Effect

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Effect