Skip to main content

ToolResult

Struct ToolResult 

Source
pub struct ToolResult { /* private fields */ }
Expand description

A transcript record containing one closed tool result.

Item metadata is an independent transport channel and is never reconstructed from, or written back into, tool_call::ToolResult output metadata.

ModelVisibility is a free parameter at this constructor, because a composition layer restoring or rewriting a history owns both halves of an exchange. The records reef itself commits take the visibility of the Assistant record carrying the call, so reef never authors a half-hidden exchange.

use reef_core::transcript::item;
use reef_core::value::{content, tool_call};
let item = item::ToolResult::new(
    tool_call::Id::new("call-1".into()), tool_call::Name::new("search".into()),
    tool_call::ToolResult::no_output(), item::ModelVisibility::Visible, Some(content::Metadata::new()),
);
assert_eq!(item.call_id().as_str(), "call-1");
assert!(item.metadata().is_some());
assert!(!item.is_business_error());
ⓘ
use reef_core::transcript::item;
use reef_core::value::tool_call;
let _forged = item::ToolResult {
    call_id: tool_call::Id::new("id".into()), tool_name: tool_call::Name::new("tool".into()),
    result: tool_call::ToolResult::no_output(), visibility: item::ModelVisibility::Visible, metadata: None,
};

Implementations§

Source§

impl ToolResult

Source

pub const fn new( call_id: Id, tool_name: Name, result: ToolResult, visibility: ModelVisibility, metadata: Option<Metadata>, ) -> Self

Creates a tool-result record with independent item metadata.

Source

pub const fn call_id(&self) -> &Id

Returns the call identity used for correlation.

Source

pub const fn tool_name(&self) -> &Name

Returns the name of the tool that produced the result.

Source

pub const fn result(&self) -> &ToolResult

Returns the closed tool result.

Source

pub const fn visibility(&self) -> ModelVisibility

Returns this record’s model visibility.

Source

pub const fn metadata(&self) -> Option<&Metadata>

Returns independent item-level metadata, preserving absent versus empty.

Source

pub const fn is_business_error(&self) -> bool

Reports whether the result is an explicit business error.

Trait Implementations§

Source§

impl Clone for ToolResult

Source§

fn clone(&self) -> Self

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 ToolResult

Source§

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

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

impl<'de> Deserialize<'de> for ToolResult

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

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

impl Serialize for ToolResult

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::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<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> 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.