Enum GenerateEvent 

pub enum GenerateEvent<C = GenerationContinuation> {
    Started {
        model: ModelId,
    },
    ContentDelta {
        delta: String,
    },
    ThinkingDelta {
        delta: String,
    },
    HostedTool(Box<HostedToolOutput>),
    Usage(Usage),
    Completed(Box<GenerateResponse<C>>),
}

Incremental generation event.

Variants

Started

Stream metadata is ready.

Fields

model: ModelId

Exact model producing the stream.

ContentDelta

Incremental visible text.

Fields

delta: String

Text appended by this event.

ThinkingDelta

Incremental provider-authored thinking summary.

Fields

delta: String

Thinking text appended by this event.

HostedTool(Box<HostedToolOutput>)

Incremental provider-hosted tool activity.

Usage(Usage)

Updated provider usage accounting.

Completed(Box<GenerateResponse<C>>)

Terminal normalized response.

Implementations

impl<C> GenerateEvent<C>

pub fn try_map_continuation<D>( self, map: impl FnMut(C) -> Result<D, KitError>, ) -> Result<GenerateEvent<D>, KitError>

Maps continuation state carried by a completion event.

Errors

Returns the callback error for a completion continuation. Other events retain their data without invoking the callback.

Examples

use providers_kit::{ModelId, generation::{GenerateResponse, Message, FinishReason, Usage}};
let response = GenerateResponse {
    model: ModelId::new("exact-model")?,
    message: Message::assistant_text("done")?.with_continuation(7_u32)?,
    finish_reason: Some(FinishReason::Stop),
    citations: Vec::new(),
    artifacts: Vec::new(),
    hosted_tool_outputs: Vec::new(),
    usage: Usage::default(),
};
use providers_kit::generation::GenerateEvent;
let event = GenerateEvent::Completed(Box::new(response));
let mapped = event.try_map_continuation(|value| Ok(value.to_string()))?;
assert!(
    matches!(mapped, GenerateEvent::Completed(response) if response.message.continuation().map(String::as_str) == Some("7"))
);

Trait Implementations

impl<C: Clone> Clone for GenerateEvent<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug> Debug for GenerateEvent<C>

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for GenerateEvent<C>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C: PartialEq> PartialEq for GenerateEvent<C>

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

Equality operator ==.

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

Inequality operator !=.

impl<C> Serialize for GenerateEvent<C>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C: PartialEq> StructuralPartialEq for GenerateEvent<C>