Enum TextModelError 

#[non_exhaustive]
pub enum TextModelError {
    NotConfigured,
    Rejected(String),
    Transient {
        retry_after: Option<Duration>,
    },
    Transport(String),
    Unsupported(Capability),
    InvalidSchema(String),
    SchemaViolation(String),
    ImageLimit(ImageLimit),
}

Completion failures.

NotConfigured sits on the error enum here, unlike SendOutcome::NotConfigured and PushOutcome::NotConfigured: a completion has no “delivered but not configured” middle state, so an unwired tier is an error the caller matches, not an outcome it inspects.

Transient deliberately carries only retry_after, where PushError::Transient also carries a message: with no provider text of its own there is nothing to scrub, and provider text belongs on Rejected and Transport.

The two variants that carry provider text are sanitized in Display, the same way PushError’s and MailError’s are (issue #235). What an adapter wraps is the provider’s own words, and a prompt is exactly the kind of value that rides back in them — a drafting module quotes a customer’s note, and the provider’s 4xx quotes it straight back. Display therefore runs it through crate::logging::scrub_text; Debug still shows the raw string for tests.

#[non_exhaustive]: a port’s failure set grows with its shape, and Unsupported is exactly such a growth — a caller that matches the variants it knows and treats anything else as a transport failure should not have to recompile when one is added.

Variants (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.

NotConfigured

The tier asked for has no adapter — the venture did not wire it. Nothing is wrong with the prompt: a module may degrade, the way it degrades on a NotConfigured mailer, and RoutingTextModel answers this for every tier it has no adapter for.

Rejected(String)

The provider refused the request (a 4xx), or refused the prompt’s content or schema; not retryable without a change.

Transient

A transient failure (a 5xx, a 429, a transport error): retry later, and not before retry_after when the provider named one. Carries no message — provider text belongs on Rejected and Transport.

Fields

retry_after: Option<Duration>

Transport(String)

The request never completed as a conversation — the adapter could not reach the provider, or the answer did not survive the hop.

Unsupported(Capability)

The model behind this tier cannot do what the prompt asked for — a prompt carrying Prompt::tools or image Parts reached an adapter whose TextModel::supports is false for Capability::Tools or Capability::Images, so the adapter was never called. A fixed sentence, never provider text, so there is nothing to scrub.

InvalidSchema(String)

The schema itself cannot be honoured: it uses a JSON Schema keyword the built-in validator does not implement (a $ref, a pattern, an if), or is malformed. This is a caller bug — the schema was written by the caller, not the model — so the model was never called. Raised by TextModelExt::complete_json before the first request.

SchemaViolation(String)

The model’s answer did not conform to the required schema, after the one repair retry TextModelExt::complete_json allows. Carries only the schema path and reason the answer failed (for example the property "price" is invalid: …) — never the model’s own output, which may hold the personal data the schema was there to structure.

ImageLimit(ImageLimit)

The prompt’s images crossed a bound Prompt::check_images enforces: too many, one too large, or too large together.

Implementations

impl TextModelError

pub fn retry_after(&self) -> Option<Duration>

How long the provider asked the caller to wait, where it said. An Unsupported capability is not a back-off: no wait makes a model grow a capability it lacks.

Trait Implementations

impl Clone for TextModelError

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 TextModelError

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

Formats the value using the given formatter.

impl Display for TextModelError

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

Formats the value using the given formatter.

impl Eq for TextModelError

impl Error for TextModelError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for TextModelError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextModelError