Struct MockTurn 

pub struct MockTurn { /* private fields */ }

Available on crate feature test-utils only.

A scripted non-streaming mock completion turn.

Implementations

impl MockTurn

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

Create a text response turn.

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

Create a tool-call response turn.

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

Create a provider-error response turn.

pub fn provider_response_error( status: StatusCode, body: impl Into<String>, request_id: impl Into<String>, ) -> Self

Create a provider-response error turn carrying a transport request id (rig#2314): the scripted failure a test uses to assert error-identity attribution.

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

Create a request-error response turn.

pub fn from_content(content: AssistantContent) -> Self

Create a response turn from one assistant content item.

pub fn from_contents( content: impl IntoIterator<Item = AssistantContent>, ) -> Self

Create a response turn from assistant content items.

Infallible now that content is a Vec: an empty turn is a shape a provider can genuinely return, so it is a value to build, not an error.

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

Attach a provider-specific call ID to a tool-call response turn.

pub fn with_usage(self, usage: Usage) -> Self

Override usage for this turn.

pub fn with_message_id(self, message_id: impl Into<String>) -> Self

Set a provider-assigned assistant message ID for this turn.

pub fn with_response_id(self, response_id: impl Into<String>) -> Self

Set a provider-assigned response-scoped ID for this turn.

pub fn with_provider_request_id(self, request_id: impl Into<String>) -> Self

Set a provider transport request id for this turn.

pub fn with_finish_reason(self, finish_reason: FinishReason) -> Self

Set the terminal finish reason for this turn.

Without this, a mocked blocking turn always reports None, which leaves the whole blocking half of the truncation contract (rig#2322) unexercisable — the streamed mock could script a reason and the blocking one could not.

pub fn with_raw(self, raw: Value) -> Self

Script the provider’s own response for this turn — what a real seam would serialize from its raw type. Attached to the response as-is, so agent tests can prove the payload reaches every observer of the turn without a live provider. A turn without a scripted payload reports raw: Value::Null, so a non-null raw in a test means the scripted value arrived, never that the mock invented one.

Trait Implementations

impl Clone for MockTurn

fn clone(&self) -> MockTurn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MockTurn

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

Formats the value using the given formatter.