Skip to main content

ToolSafetyMetadata

ai_agents::tools

Struct ToolSafetyMetadata 

Source 
pub struct ToolSafetyMetadata {
Show 14 fields
    pub read_only: bool,
    pub concurrency_safe: bool,
    pub operation: ToolOperationKind,
    pub side_effect_level: ToolSideEffectLevel,
    pub requires_network: bool,
    pub destructive: bool,
    pub open_world: bool,
    pub host_dependent: bool,
    pub requires_user_interaction: bool,
    pub supports_cancellation: bool,
    pub default_requires_approval: bool,
    pub should_defer_schema: bool,
    pub max_output_chars: Option<usize>,
    pub max_result_size_chars: Option<usize>,

}
Expand description

Static safety metadata attached to a tool registration.

Fields§

§read_only: bool

True when the tool does not mutate local or external state.

§concurrency_safe: bool

True when calls can run concurrently without observable races.

§operation: ToolOperationKind

Default operation category for this tool.

§side_effect_level: ToolSideEffectLevel

Default side-effect level for this tool.

§requires_network: bool

True when the tool can access the network.

§destructive: bool

True when the tool can destroy or remove state.

§open_world: bool

True when the tool can reach open-ended external resources.

§host_dependent: bool

True when the tool requires a host-provided service.

§requires_user_interaction: bool

True when execution requires user interaction.

§supports_cancellation: bool

True when the executor can cancel the tool cooperatively.

§default_requires_approval: bool

True when policy should require approval unless explicitly allowed.

§should_defer_schema: bool

True when large schemas should be loaded lazily in future registry flows.

§max_output_chars: Option<usize>

Default maximum model-facing output characters.

§max_result_size_chars: Option<usize>

Default maximum stored result characters.

Implementations§

Source§

impl ToolSafetyMetadata

Source

pub fn conservative_unknown() -> ToolSafetyMetadata

Returns fail-closed metadata for tools that do not declare safety details.

Source

pub fn read_only(operation: ToolOperationKind) -> ToolSafetyMetadata

Returns metadata for a read-only tool with the given operation kind.

Source

pub fn compute() -> ToolSafetyMetadata

Returns metadata for deterministic or local compute tools.

Trait Implementations§

Source§

impl Clone for ToolSafetyMetadata

Source§

fn clone(&self) -> ToolSafetyMetadata

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolSafetyMetadata

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ToolSafetyMetadata

Source§

fn default() -> ToolSafetyMetadata

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ToolSafetyMetadata

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ToolSafetyMetadata

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more