Skip to main content

ToolPart

Struct ToolPart 

Source
pub struct ToolPart(/* private fields */);
Expand description

A field-complete Part verified for use in tool output.

This wrapper can only be obtained through ToolPart::try_from_part.

ⓘ
use reef_core::value::{content, tool_call};
let _unchecked = tool_call::ToolPart(content::Part::text("result".into()));

Implementations§

Source§

impl ToolPart

Source

pub fn try_from_part(part: Part) -> Result<Self, ToolPartError>

Verifies that part has one of the five known kinds without changing it.

The check is deliberately narrow: ordinary Part paths remain open, and only tool output has to be one of the five interpretable kinds.

§Errors

ToolPartError::UnknownKind, carrying the rejected number, if the part’s canonical kind is not one of the five this crate can interpret. Tool output is the one Part consumer that narrows: every other path keeps an unrecognised numeric kind so a provider extension survives a round trip, but a tool result the model will act on may not carry a kind reef cannot name. Nothing else can fail here — an accepted part is retained whole, with every field and every presence distinction intact.

Source

pub const fn as_part(&self) -> &Part

Returns the complete verified Part.

Source

pub fn into_part(self) -> Part

Transfers the complete verified Part.

Trait Implementations§

Source§

impl Clone for ToolPart

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 ToolPart

Source§

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

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

impl<'de> Deserialize<'de> for ToolPart

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 ToolPart

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.