Enum SideEffect 

pub enum SideEffect {
    Read,
    Write,
    Idempotent,
    Destructive,
    External,
    Expensive,
    Network,
}

Standard side-effect categories for an agent tool.

String form matches the Python sibling library: "read", "write", "idempotent", "destructive", "external", "expensive", "network".

Variants

Read

Reads data. No state mutation. Safe to parallelize and retry.

Write

Mutates internal state. Not parallel-safe by default.

Idempotent

Repeated calls with the same args produce the same effect. Retry-safe.

Destructive

Removes or invalidates state (delete, drop, purge). Never auto-retry.

External

Touches a third-party system (email, payments, webhooks). Not retry-safe without SideEffect::Idempotent.

Expensive

High cost (tokens, money, time). Caller may want extra confirmation.

Network

Makes a network call. Subject to retryable transient errors.

Implementations

impl SideEffect

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

Stable string slug used by [Display] and FromStr.

Trait Implementations

impl Clone for SideEffect

fn clone(&self) -> SideEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SideEffect

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

Formats the value using the given formatter.

impl Display for SideEffect

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

Formats the value using the given formatter.

impl FromIterator<SideEffect> for SideEffects

fn from_iter<I: IntoIterator<Item = SideEffect>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for SideEffect

type Err = ParseSideEffectError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for SideEffect

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

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 SideEffect

fn eq(&self, other: &SideEffect) -> 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 Copy for SideEffect

impl Eq for SideEffect

impl StructuralPartialEq for SideEffect