Enum ToolEffect 

pub enum ToolEffect {
    FsRead,
    FsWrite,
    FsDelete,
    ProcessSpawn,
    NetworkRequest,
    CredentialRead,
    ClipboardRead,
    UserInteraction,
    ExternalMutation,
    Unknown(String),
}

Declared capability or external effect of a tool invocation.

Variants

FsRead

Read filesystem content.

FsWrite

Create or modify filesystem content.

FsDelete

Delete filesystem content.

ProcessSpawn

Spawn or control an operating-system process.

NetworkRequest

Perform a network request.

CredentialRead

Read credentials or secret material.

ClipboardRead

Read clipboard content.

UserInteraction

Require direct user interaction.

ExternalMutation

Mutate state in an external system.

Unknown(String)

Future namespaced effect unknown to this runtime version.

Implementations

impl ToolEffect

pub fn as_str(&self) -> &str

Returns the canonical dotted effect name.

pub const fn is_unknown(&self) -> bool

Returns whether this runtime does not understand the effect semantics.

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<'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 Eq for ToolEffect

impl FromStr for ToolEffect

type Err = ToolEffectParseError

The associated error which can be returned from parsing.

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

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

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 Ord for ToolEffect

fn cmp(&self, other: &ToolEffect) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ToolEffect

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ToolEffect

fn partial_cmp(&self, other: &ToolEffect) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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 StructuralPartialEq for ToolEffect