Enum MockStreamEvent 

pub enum MockStreamEvent {
    Text(String),
    TextStart {
        id: String,
        additional_params: Option<Value>,
    },
    TextAdditionalParams(Value),
    ToolCall {
        id: String,
        name: String,
        arguments: Value,
        call_id: Option<String>,
    },
    ToolCallNameDelta {
        id: String,
        name: String,
    },
    ToolCallArgumentsDelta {
        id: String,
        arguments: String,
    },
    ToolCallEnd {
        id: String,
    },
    Reasoning {
        id: String,
        text: String,
    },
    ReasoningDelta {
        id: String,
        reasoning: String,
    },
    Unknown(Value),
    RequestId(String),
    FinalResponse(Finish),
    Error(MockError),
}

Available on crate feature test-utils only.

Scripted streaming event yielded by MockCompletionModel.

Variants

Text(String)

Text chunk.

TextStart

Start a new text part, with the provider item it is decoded from.

Fields

id: String

additional_params: Option<Value>

TextAdditionalParams(Value)

Fields merged into the current text part’s provider item.

ToolCall

Complete tool call event.

Fields

id: String

name: String

arguments: Value

call_id: Option<String>

ToolCallNameDelta

A tool call’s name, as a wire streams it.

Fields

id: String

name: String

ToolCallArgumentsDelta

A fragment of a tool call’s arguments.

Fields

id: String

arguments: String

ToolCallEnd

The end of a tool call streamed as fragments: the call closes with what they carried, as a wire’s step-stop does.

Fields

id: String

Reasoning

Complete reasoning event.

Fields

id: String

text: String

ReasoningDelta

Reasoning delta event.

Fields

id: String

reasoning: String

Unknown(Value)

Provider-native output item that Rig does not model.

RequestId(String)

The transport request id of this turn. The mock transport reports it, as a real transport reports a response header; the decoder never sees it. Its position in the turn does not matter; when a turn scripts more than one, the first wins.

FinalResponse(Finish)

The provider’s end of the reply.

Error(MockError)

A failure, which ends the reply.

Implementations

impl MockStreamEvent

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

Create a text chunk.

pub fn text_start( id: impl Into<String>, additional_params: Option<Value>, ) -> Self

Start a new text content block identified by id.

pub fn text_additional_params(additional_params: Value) -> Self

Add provider-specific metadata to the current text content block.

pub fn tool_call( id: impl Into<String>, name: impl Into<String>, arguments: Value, ) -> Self

Create a complete tool call event.

pub fn with_call_id(self, call_id: impl Into<String>) -> Self

Attach a provider-specific call ID to a complete tool call event.

pub fn tool_call_name_delta( id: impl Into<String>, name: impl Into<String>, ) -> Self

Create a tool call name delta.

pub fn tool_call_arguments_delta( id: impl Into<String>, arguments: impl Into<String>, ) -> Self

Create a tool call arguments delta.

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

Create the end of a tool call streamed as deltas.

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

Create a complete reasoning event with the default mock id ("reasoning-0"). Use Self::with_reasoning_id for tests that need distinct reasoning items.

pub fn with_reasoning_id(self, reasoning_id: impl Into<String>) -> Self

Attach a provider-specific reasoning ID to a complete reasoning event.

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

Create a reasoning delta event with the default mock id ("reasoning-0"). Use Self::reasoning_delta_with_id for tests that need distinct reasoning items.

pub fn reasoning_delta_with_id( id: impl Into<String>, reasoning: impl Into<String>, ) -> Self

Create a reasoning delta event with an explicit reasoning item id.

pub fn unknown(value: Value) -> Self

Create an unmodeled provider output item.

pub fn final_response(usage: Usage) -> Self

Create the provider’s end of the reply, with usage.

pub fn final_response_with_default_usage() -> Self

Create a final response event whose usage reports no counter.

pub fn final_response_with_total_tokens(total_tokens: u64) -> Self

Create a final response event whose usage has only total_tokens set.

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

Create a stream error event.

Trait Implementations

impl Clone for MockStreamEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MockStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MockStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MockStreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MockStreamEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MockStreamEvent