Enum EffectKind 

pub enum EffectKind {
    Read,
    IdempotentWrite,
    ReversibleWrite,
    IrreversibleWrite,
}

What re-executing an effect does to the outside world.

The kind decides how much the runtime may retry on its own (see Capabilities::unknown_plan in agent-effects).

Variants

Read

No externally visible mutation, e.g. fetching a balance.

IdempotentWrite

Repeating the same request leaves the same end state, e.g. PUT /users/123.

ReversibleWrite

Changes external state, but a compensating operation exists, e.g. reserving inventory.

IrreversibleWrite

Changes external state and cannot be reliably undone, e.g. sending an email.

Implementations

impl EffectKind

pub const fn is_naturally_idempotent(self) -> bool

Whether executing the same request twice is harmless on its own, without help from the remote system.

pub const fn as_str(self) -> &'static str

The stable storage representation.

pub fn parse(s: &str) -> Option<EffectKind>

Parses the storage representation produced by Self::as_str.

Trait Implementations

impl Clone for EffectKind

fn clone(&self) -> EffectKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EffectKind

impl Debug for EffectKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EffectKind

fn deserialize<__D>( __deserializer: __D, ) -> Result<EffectKind, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EffectKind

impl Hash for EffectKind

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EffectKind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EffectKind

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EffectKind