Struct MockTurn 

pub struct MockTurn { /* private fields */ }

Available on crate feature test-utils only.

A scripted non-streaming mock completion turn.

A turn is data: a script serializes, so a scripted model can be written to a fixture and read back (see MockCompletionModel::script).

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. An empty name scripts a provider error instead: no call can be built without a name.

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_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 carries the scripted turn itself, serialized — the mock’s own document, the same capture every real adapter performs — so a scripted value in a test is distinguishable from the mock’s default by content.

pub fn raw(&self) -> Result<Value, ProviderError>

The provider document the mock attaches to this turn’s response: the scripted payload when one was supplied, otherwise the turn itself, serialized. Public so a test can state the expected raw of a recorded call without repeating the mock’s serialization. An error turn has no document.

Trait Implementations

impl Clone for MockTurn

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 MockTurn

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MockTurn

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MockTurn

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MockTurn

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 MockTurn