Struct FixtureDocsClient 

pub struct FixtureDocsClient {
    pub base_url: Option<String>,
    pub args: BTreeMap<String, Vec<String>>,
    pub config: Option<Value>,
}

How a documentation snippet constructs its client, for fixtures whose subject is the client configuration.

A snippet is rendered with the mock harness stripped, so the generator’s client construction degenerates to factory(<credential>, <no base URL>, <defaults…>). A configuration/* fixture documenting a client setting can therefore not show the setting it is named for unless it says so here.

This is docs-only. Generators reach it through super::Fixture::docs_client and must pass it in from a documentation-only call site, so it cannot retarget the executable e2e suite, whose client has to keep pointing at the mock server.

Fields

base_url: Option<String>

Base URL the snippet’s client is constructed with.

Carried as plain data rather than a rendered expression: every binding wraps an optional string differently (Some("…".to_string()) in Rust, a bare literal in Java), and that wrapping is the generator’s knowledge, not the fixture’s.

args: BTreeMap<String, Vec<String>>

Verbatim argument expressions following the base URL, keyed by binding language (rust, java, …).

Overrides [e2e.call.overrides.<lang>] client_factory_trailing_args for this fixture alone; a language absent from the map keeps the configured list. Values are emitted as written, so they must be valid source in the target language — use this for settings with no language-agnostic representation (timeouts, retry policies, builder expressions).

config: Option<Value>

Client configuration, as a JSON object, for a fixture whose subject is how the client is configured (a budget, a cache) rather than which call it makes.

~keep The snippet constructs the client through the language’s client_factory_from_json (see CallOverride) with this value serialized verbatim as a string literal. It is the complete configuration: nothing is merged into it, so include the credential and any base URL the factory needs, and base_url/args above do not apply. Unlike those, it is part of what the fixture tests, so a fixture that declares it is excluded from the executable e2e suite instead of running against a plain client.

Implementations

impl FixtureDocsClient

pub fn args_for(&self, language: &str) -> Option<&[String]>

Verbatim trailing argument expressions this fixture declares for language, or None when it defers to the configured default.

Trait Implementations

impl Clone for FixtureDocsClient

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 FixtureDocsClient

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

Formats the value using the given formatter.

impl Default for FixtureDocsClient

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FixtureDocsClient

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FixtureDocsClient

impl PartialEq for FixtureDocsClient

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FixtureDocsClient

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 FixtureDocsClient