Skip to main content

MockStreamEvent

Enum MockStreamEvent 

Source
pub enum MockStreamEvent {
Show 14 variants 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, content: ReasoningContent, }, ReasoningDelta { id: String, reasoning: String, }, MessageId(String), Unknown(Value), RequestId(String), FinalResponse(Finish), Error(MockError),
}
Available on crate feature test-utils only.
Expand description

Scripted streaming event yielded by MockCompletionModel.

Variants§

§

Text(String)

Text chunk.

§

TextStart

Start a new text part with optional provider metadata.

Fields

§additional_params: Option<Value>
§

TextAdditionalParams(Value)

Provider-specific metadata for the current text part.

§

ToolCall

Complete tool call event.

Fields

§name: String
§arguments: Value
§call_id: Option<String>
§

ToolCallNameDelta

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

Fields

§name: String
§

ToolCallArgumentsDelta

A fragment of a tool call’s arguments.

Fields

§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

§

Reasoning

Complete reasoning event.

Fields

§

ReasoningDelta

Reasoning delta event.

Fields

§reasoning: String
§

MessageId(String)

Provider-assigned message ID.

§

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§

Source§

impl MockStreamEvent

Source

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

Available on crate features test-utils only.

Create a text chunk.

Source

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

Available on crate features test-utils only.

Start a new text content block identified by id.

Source

pub fn text_additional_params(additional_params: Value) -> MockStreamEvent

Available on crate features test-utils only.

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

Source

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

Available on crate features test-utils only.

Create a complete tool call event.

Source

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

Available on crate features test-utils only.

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

Source

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

Available on crate features test-utils only.

Create a tool call name delta.

Source

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

Available on crate features test-utils only.

Create a tool call arguments delta.

Source

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

Available on crate features test-utils only.

Create the end of a tool call streamed as deltas.

Source

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

Available on crate features test-utils only.

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

Source

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

Available on crate features test-utils only.

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

Source

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

Available on crate features test-utils only.

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.

Source

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

Available on crate features test-utils only.

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

Source

pub fn message_id(id: impl Into<String>) -> MockStreamEvent

Available on crate features test-utils only.

Create a provider-assigned message ID event.

Source

pub fn unknown(value: Value) -> MockStreamEvent

Available on crate features test-utils only.

Create an unmodeled provider output item.

Source

pub fn final_response(usage: Usage) -> MockStreamEvent

Available on crate features test-utils only.

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

Source

pub fn final_response_with_default_usage() -> MockStreamEvent

Available on crate features test-utils only.

Create a final response event whose usage reports no counter.

Source

pub fn final_response_with_total_tokens(total_tokens: u64) -> MockStreamEvent

Available on crate features test-utils only.

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

Source

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

Available on crate features test-utils only.

Create a stream error event.

Trait Implementations§

Source§

impl Clone for MockStreamEvent

Source§

fn clone(&self) -> MockStreamEvent

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 MockStreamEvent

Source§

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

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

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

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<MockStreamEvent, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for MockStreamEvent

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for MockStreamEvent

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for MockStreamEvent

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> DynClone for T
where T: Clone,

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

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

impl<T> Instrument for T

Source§

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

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

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

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

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

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

impl<T> WithSubscriber for T

Source§

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
Source§

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

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