Skip to main content

StreamEventEmitter

Trait StreamEventEmitter 

Source
pub trait StreamEventEmitter: Send {
    // Required method
    fn emit(&mut self, event: ResponseStreamEvent);

    // Provided methods
    fn response_created(&mut self, response: Response) { ... }
    fn response_in_progress(&mut self, response: Response) { ... }
    fn response_completed(&mut self, response: Response) { ... }
    fn response_failed(&mut self, response: Response) { ... }
    fn output_item_added(
        &mut self,
        response_id: &str,
        output_index: usize,
        item: OutputItem,
    ) { ... }
    fn output_item_done(
        &mut self,
        response_id: &str,
        output_index: usize,
        item: OutputItem,
    ) { ... }
    fn output_text_delta(
        &mut self,
        response_id: &str,
        item_id: &str,
        output_index: usize,
        content_index: usize,
        delta: &str,
    ) { ... }
    fn reasoning_delta(
        &mut self,
        response_id: &str,
        item_id: &str,
        output_index: usize,
        delta: &str,
    ) { ... }
}
Expand description

Trait for emitting Open Responses streaming events.

Required Methods§

Source

fn emit(&mut self, event: ResponseStreamEvent)

Emit a streaming event.

Provided Methods§

Source

fn response_created(&mut self, response: Response)

Emit a response created event.

Source

fn response_in_progress(&mut self, response: Response)

Emit a response in progress event.

Source

fn response_completed(&mut self, response: Response)

Emit a response completed event.

Source

fn response_failed(&mut self, response: Response)

Emit a response failed event.

Source

fn output_item_added( &mut self, response_id: &str, output_index: usize, item: OutputItem, )

Emit an output item added event.

Source

fn output_item_done( &mut self, response_id: &str, output_index: usize, item: OutputItem, )

Emit an output item done event.

Source

fn output_text_delta( &mut self, response_id: &str, item_id: &str, output_index: usize, content_index: usize, delta: &str, )

Emit a text delta event.

Source

fn reasoning_delta( &mut self, response_id: &str, item_id: &str, output_index: usize, delta: &str, )

Emit a reasoning delta event.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§