Enum ToolEffect 

#[non_exhaustive]
pub enum ToolEffect {
    ReadOnly,
    Mutating,
    Destructive,
}

Side-effect classification of a tool — surfaces both to the runtime (Approver defaults, retry policy) and to the LLM (rendered in the tool description so the model can reason about safety on its own).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ReadOnly

Pure read — no side effects on external state. Safe to call in parallel, retry on transport hiccups, cache aggressively. Examples: search, fetch, calculator.

Mutating

Changes external state but the change is recoverable (overwrite, undo, idempotent overwrite). Retry-safe with a reasonable backoff. Examples: write a file, set a config value, update a record.

Destructive

Irreversible — once it runs the operator cannot undo. Default Approver policy MAY require human confirmation. Retry is off by default. Examples: send an email, post a payment, delete a row, run an rm -rf.

Implementations

impl ToolEffect

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

Stable wire string used by OTel attributes (gen_ai.tool.effect) and event-log records.

Trait Implementations

impl Clone for ToolEffect

fn clone(&self) -> ToolEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolEffect

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

Formats the value using the given formatter.

impl Default for ToolEffect

fn default() -> ToolEffect

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolEffect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ToolEffect

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

Formats the value using the given formatter.

impl Hash for ToolEffect

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 ToolEffect

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ToolEffect

impl Eq for ToolEffect

impl StructuralPartialEq for ToolEffect