Skip to main content

StepContent

ferrin_core::generate_text

Enum StepContent

#[non_exhaustive]pub enum StepContent {
    Text {
        text: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    Reasoning {
        text: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    ReasoningFile(GeneratedFile),
    File(GeneratedFile),
    Custom {
        kind: CustomKind,
        provider_metadata: Option<ProviderMetadata>,
    },
    Source(Source),
    ToolCall(ParsedToolCall),
    ToolResult(ToolResult),
    ToolError(ToolExecutionError),
    ToolApprovalRequest(ToolApprovalRequestContent),
    ToolApprovalResponse(ToolApprovalResponseContent),
    ToolOutputDenied(ToolOutputDenied),
}

Expand description

A content part of a step.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text

Generated text.

Fields

§text: String

The text.

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata.

Reasoning

Reasoning text.

Fields

§text: String

The text.

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata.

ReasoningFile(GeneratedFile)

A reasoning artifact stored as a file.

File(GeneratedFile)

A generated file.

Custom

Provider-specific content.

Fields

§kind: CustomKind

Kind of the content.

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata.

Source(Source)

A citation source.

ToolCall(ParsedToolCall)

A parsed tool call.

ToolResult(ToolResult)

A tool result (client- or provider-executed).

ToolError(ToolExecutionError)

A tool error (client- or provider-executed).

ToolApprovalRequest(ToolApprovalRequestContent)

A request to approve a tool call.

ToolApprovalResponse(ToolApprovalResponseContent)

An automatic approval decision made by the approval policy.

ToolOutputDenied(ToolOutputDenied)

A tool call whose execution was denied.

Implementations§

impl StepContent

pub fn text(text: impl Into<String>) -> Self

Creates a text part.

pub fn kind_name(&self) -> &'static str

Returns the wire name of the variant.

Trait Implementations§

impl Clone for StepContent

fn clone(&self) -> StepContent

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

impl Debug for StepContent

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for StepContent

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for StepContent

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl Serialize for StepContent

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for StepContent

Auto Trait Implementations§

impl !Freeze for StepContent

impl RefUnwindSafe for StepContent

impl Send for StepContent

impl Sync for StepContent

impl Unpin for StepContent

impl UnsafeUnpin for StepContent

impl UnwindSafe for StepContent

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more