Skip to main content

Scenario

Enum Scenario 

Source
#[non_exhaustive]
pub enum Scenario {
Show 24 variants ValidStructured, MalformedJson, UnknownField, MissingField, MultipleActs, ToolCallIds, StreamingReconstruction, CachedUsage, EmptyOutput, Refusal, SlowResponse, RateLimited, Authentication, ContextOverflow, SecretInBody, Authorization, ModelNotFound, RequestTimeout, InvalidRequest, ServerError, ServiceUnavailable, ContentFilter, ExpiredCredential, QuotaExhausted,
}
Expand description

One provider behaviour the suite needs a mock for.

A fixture translates a scenario into vendor framing: the endpoint, the body shape, the status code. What the body says comes from payloads.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

ValidStructured

A schema-conformant one-act plan: payloads::valid_plan.

§

MalformedJson

A body that is not JSON: payloads::MALFORMED_JSON.

§

UnknownField

A two-act plan whose second act carries a forbidden field: payloads::plan_with_unknown_field.

§

MissingField

A two-act plan whose second act lacks a required field: payloads::plan_with_missing_field.

§

MultipleActs

A well-formed two-act plan: payloads::two_act_plan.

§

ToolCallIds

A single tool call named payloads::TOOL_NAME with id payloads::EXPECTED_CALL_ID.

§

StreamingReconstruction

The same answer available both whole and streamed, so the suite can compare them. Mount both: the fixture distinguishes them by the streaming flag the adapter puts on the wire.

Three rows read this scenario, and each asks something of the streamed half:

  • it must reassemble into the whole answer, content and finish reason alike;
  • it must deliver the prose in at least two wire events, or Check::StreamingIncremental cannot tell an adapter that streams from one that buffers the body and emits a single delta at the end;
  • it must report the same token usage as the whole half — which means both halves report usage at all, usually on a final frame.
§

CachedUsage

A successful answer whose reported usage carries a cache figure: payloads::USAGE_INPUT_TOKENS prompt tokens of which payloads::USAGE_CACHED_TOKENS came from the provider’s cache, and payloads::USAGE_OUTPUT_TOKENS generated.

Mount the vendor’s own cache fields — prompt_tokens_details, cache_read_input_tokens, cacheReadInputTokens, cachedContentTokenCount — rather than inventing a shape, because the row is about reading them correctly. The answer itself is prose; only the counts matter.

§

EmptyOutput

A successful status with no usable content.

§

Refusal

The vendor’s refusal shape, carrying payloads::REFUSAL_TEXT.

§

SlowResponse

A successful answer delayed by payloads::SLOW_RESPONSE_DELAY, used by both the timeout and the cancellation checks.

§

RateLimited

HTTP 429 with Retry-After: {} seconds (payloads::RETRY_AFTER_SECONDS).

§

Authentication

HTTP 401 with the vendor’s authentication error body.

§

ContextOverflow

The vendor’s context-length error body.

§

SecretInBody

A body with payloads::DUMMY_API_KEY planted inside it, so the redaction check has something specific to hunt for.

§

Authorization

HTTP 403: the credential is valid and not entitled to this model.

§

ModelNotFound

HTTP 404: the configured model does not exist at this provider.

§

RequestTimeout

HTTP 408: the provider gave up waiting on its own side.

§

InvalidRequest

HTTP 400 that is genuinely a bad request — not a context-length problem. Mount a body no reasonable adapter could mistake for one: these two rows exist to be told apart.

§

ServerError

HTTP 500.

§

ServiceUnavailable

HTTP 503.

§

ContentFilter

The vendor’s safety-filter shape, whether that is a failure body or a successful answer whose finish reason says the content was filtered.

§

ExpiredCredential

The vendor’s expired credential shape, whatever status carries it.

Mount the body a short-lived token produces once it lapses — usually a 401 with a code such as token_expired, distinguishable from the 401 Authentication mounts only by what the body says.

§

QuotaExhausted

The vendor’s quota or billing shape, whatever status carries it.

Mount the body an exhausted quota or an empty credit balance produces. If the vendor uses 429 for it — several do — mount the 429 with its real body: telling it apart from RateLimited is the point of the row.

Implementations§

Source§

impl Scenario

Source

pub const ALL: [Scenario; 14]

The scenarios behind the feature rows of Check::ALL.

A full run also mounts SecretInBody and every scenario in STATUS.

Source

pub const STATUS: [Scenario; 9]

The scenarios behind the per-status rows a fixture must also mount.

Authentication, RateLimited and ContextOverflow already cover three of the thirteen StatusRows, and StatusRow::ConnectionReset needs no mock at all, so only these nine are new.

Source

pub const fn as_str(self) -> &'static str

Stable snake-case label.

Trait Implementations§

Source§

impl Clone for Scenario

Source§

fn clone(&self) -> Scenario

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 Copy for Scenario

Source§

impl Debug for Scenario

Source§

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

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

impl Display for Scenario

Source§

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

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

impl Eq for Scenario

Source§

impl Hash for Scenario

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Scenario

Source§

fn cmp(&self, other: &Scenario) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Scenario

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Scenario

Source§

fn partial_cmp(&self, other: &Scenario) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for Scenario

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> AsOut<T> for T
where T: Copy,

Source§

fn as_out(&mut self) -> Out<'_, T>

Returns an out reference to self.
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

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

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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, 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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