pub struct ToolInvocationCapabilities { /* private fields */ }Expand description
Runtime-facing optional behavior supported by a tool implementation.
Cooperative cancellation never proves that an external effect did not occur. Progress events are observational and cannot commit tool success.
Implementations§
Source§impl ToolInvocationCapabilities
impl ToolInvocationCapabilities
Sourcepub const fn new(
cancellation: ToolCancellationSupport,
max_progress_events: ExecutionCount,
) -> Self
pub const fn new( cancellation: ToolCancellationSupport, max_progress_events: ExecutionCount, ) -> Self
Constructs invocation behavior flags.
Sourcepub const fn cancellation(&self) -> ToolCancellationSupport
pub const fn cancellation(&self) -> ToolCancellationSupport
Returns the supported cancellation mode.
Sourcepub const fn supports_progress_events(&self) -> bool
pub const fn supports_progress_events(&self) -> bool
Returns whether bounded progress events may be emitted.
Sourcepub const fn max_progress_events(&self) -> ExecutionCount
pub const fn max_progress_events(&self) -> ExecutionCount
Returns the maximum progress events emitted by one invocation.
Trait Implementations§
Source§impl Clone for ToolInvocationCapabilities
impl Clone for ToolInvocationCapabilities
Source§impl Debug for ToolInvocationCapabilities
impl Debug for ToolInvocationCapabilities
Source§impl<'de> Deserialize<'de> for ToolInvocationCapabilities
impl<'de> Deserialize<'de> for ToolInvocationCapabilities
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl Eq for ToolInvocationCapabilities
Source§impl JsonSchema for ToolInvocationCapabilities
impl JsonSchema for ToolInvocationCapabilities
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Returns a string that uniquely identifies the schema produced by this type. Read more
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
Whether JSON Schemas generated for this type should be included directly in parent schemas,
rather than being re-used where possible using the
$ref keyword. Read moreimpl StructuralPartialEq for ToolInvocationCapabilities
Auto Trait Implementations§
impl Forget for ToolInvocationCapabilities
impl Freeze for ToolInvocationCapabilities
impl Move for ToolInvocationCapabilities
impl RefUnwindSafe for ToolInvocationCapabilities
impl Send for ToolInvocationCapabilities
impl Sync for ToolInvocationCapabilities
impl Unpin for ToolInvocationCapabilities
impl UnsafeUnpin for ToolInvocationCapabilities
impl UnwindSafe for ToolInvocationCapabilities
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more