Skip to main content

Hints

Struct Hints 

Source
pub struct Hints {
    pub readonly: Option<bool>,
    pub destructive: Option<bool>,
    pub idempotent: Option<bool>,
    pub open_world: Option<bool>,
    pub long_running: Option<bool>,
    pub concurrency_class: Option<String>,
    pub metadata: Option<Value>,
}
Expand description

Semantic and host-owned annotations for a capability tool.

Boolean values are Option<bool> so unspecified remains distinct from false. Hints inform scheduling and clients; they do not grant authority.

Fields§

§readonly: Option<bool>

The tool does not modify state.

§destructive: Option<bool>

The tool may irreversibly delete or destroy state.

§idempotent: Option<bool>

Repeating a call with the same arguments is safe.

§open_world: Option<bool>

The tool interacts with systems outside the local process.

§long_running: Option<bool>

The tool may commonly take more than a few seconds.

§concurrency_class: Option<String>

Calls sharing this non-empty key execute sequentially.

§metadata: Option<Value>

Host-owned annotations. Never include credentials or sensitive data.

Implementations§

Source§

impl Hints

Source

pub fn readonly(self, value: bool) -> Self

Mark whether the tool is read-only.

Source

pub fn destructive(self, value: bool) -> Self

Mark whether the tool can destroy state.

Source

pub fn idempotent(self, value: bool) -> Self

Mark whether identical calls are safe to repeat.

Source

pub fn open_world(self, value: bool) -> Self

Mark whether the tool reaches external systems.

Source

pub fn long_running(self, value: bool) -> Self

Mark whether the tool is commonly long-running.

Source

pub fn concurrency_class(self, value: impl Into<String>) -> Self

Serialize calls that share this scheduling class.

Source

pub fn metadata(self, value: impl Into<Value>) -> Self

Attach host-owned JSON annotations.

Trait Implementations§

Source§

impl Clone for Hints

Source§

fn clone(&self) -> Hints

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 Hints

Source§

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

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

impl Default for Hints

Source§

fn default() -> Hints

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

impl PartialEq for Hints

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Hints

Auto Trait Implementations§

§

impl Freeze for Hints

§

impl RefUnwindSafe for Hints

§

impl Send for Hints

§

impl Sync for Hints

§

impl Unpin for Hints

§

impl UnsafeUnpin for Hints

§

impl UnwindSafe for Hints

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<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> 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, 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.