pub struct ToolOutput {
pub name: String,
pub status: ToolStatus,
pub evidence: ToolEvidenceMetadata,
pub display: ToolDisplayProjection,
pub model: ToolModelProjection,
pub error: Option<String>,
}Expand description
Structured output returned by an application-owned tool executor.
Fields§
§name: StringTool name selected for execution.
status: ToolStatusExecution status.
evidence: ToolEvidenceMetadataMetadata for bounded redacted evidence retained by the application.
display: ToolDisplayProjectionUser-facing projection. This is the source for UI and ACP surfaces.
model: ToolModelProjectionModel-facing projection. This is the source for provider feedback.
error: Option<String>Failure detail when execution did not succeed.
Implementations§
Source§impl ToolOutput
impl ToolOutput
Sourcepub fn ok(name: impl Into<String>, output: Vec<String>) -> ToolOutput
pub fn ok(name: impl Into<String>, output: Vec<String>) -> ToolOutput
Build a successful output value.
Sourcepub fn failed(name: impl Into<String>, error: impl Into<String>) -> ToolOutput
pub fn failed(name: impl Into<String>, error: impl Into<String>) -> ToolOutput
Build a failed output value.
Sourcepub fn display_lines(&self) -> Vec<String>
pub fn display_lines(&self) -> Vec<String>
Return display lines, materializing the structured failure detail.
Sourcepub fn model_lines(&self) -> Vec<String>
pub fn model_lines(&self) -> Vec<String>
Return model lines, materializing the structured failure detail.
Trait Implementations§
Source§impl Clone for ToolOutput
impl Clone for ToolOutput
Source§fn clone(&self) -> ToolOutput
fn clone(&self) -> ToolOutput
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for ToolOutput
impl Debug for ToolOutput
impl Eq for ToolOutput
Source§impl PartialEq for ToolOutput
impl PartialEq for ToolOutput
impl StructuralPartialEq for ToolOutput
Auto Trait Implementations§
impl Freeze for ToolOutput
impl RefUnwindSafe for ToolOutput
impl Send for ToolOutput
impl Sync for ToolOutput
impl Unpin for ToolOutput
impl UnsafeUnpin for ToolOutput
impl UnwindSafe for ToolOutput
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> IntoMaybeUndefined<T> for T
impl<T> IntoMaybeUndefined<T> for T
Source§fn into_maybe_undefined(self) -> MaybeUndefined<T>
fn into_maybe_undefined(self) -> MaybeUndefined<T>
Converts this value into a three-state builder argument.
Source§impl<T> IntoOption<T> for T
impl<T> IntoOption<T> for T
Source§fn into_option(self) -> Option<T>
fn into_option(self) -> Option<T>
Converts this value into an optional builder argument.