Struct ProviderError 

pub struct ProviderError { /* private fields */ }

Unified error returned by every provider operation.

Use the is_*() helpers to branch on cause. The underlying variant is intentionally hidden so we can add new failure modes without a breaking change.

Internally boxed so Result<T, ProviderError> stays one machine word in the Err slot.

Examples

use llmsdk_provider::ProviderError;

let err = ProviderError::no_such_model("gpt-foo", "languageModel");
assert!(err.is_no_such_model());
assert_eq!(err.model_id(), Some("gpt-foo"));

Implementations

impl ProviderError

pub fn api_call(url: impl Into<String>, message: impl Into<String>) -> Self

Build an HTTP API call error.

is_retryable is true by default for 408 / 409 / 429 / 5xx, matching ai-sdk’s APICallError defaults. Use Self::api_call_builder for full control.

pub fn api_call_builder( url: impl Into<String>, message: impl Into<String>, ) -> ApiCallErrorBuilder

Open a builder for an API call error with optional fields.

pub fn invalid_argument( argument: impl Into<String>, message: impl Into<String>, ) -> Self

Build an invalid-argument error for a public parameter.

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

Build an invalid-prompt error.

pub fn type_validation( path: impl Into<String>, value: JsonValue, message: impl Into<String>, ) -> Self

Build a type-validation error for a JSON path.

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

Build a JSON parse error.

pub fn empty_response_body() -> Self

The provider returned an empty body where content was expected.

pub fn no_content_generated() -> Self

The provider returned successfully but produced no usable content.

pub fn no_such_model( model_id: impl Into<String>, model_type: impl Into<String>, ) -> Self

No such model id for the given model type (languageModel, …).

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

The provider does not support the requested functionality.

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

Could not load an API key from the environment / config.

pub fn too_many_embedding_values(max: usize, actual: usize) -> Self

Too many embedding inputs passed in a single call.

pub fn is_api_call(&self) -> bool

True for API-level HTTP failures.

pub fn is_retryable(&self) -> bool

True when the failure should be retried.

Currently only Self::is_api_call errors carry retry information; all others return false.

pub fn is_no_such_model(&self) -> bool

True when the error reports an unknown model id.

pub fn is_unsupported(&self) -> bool

True when the error reports unsupported functionality.

pub fn status_code(&self) -> Option<u16>

HTTP status code when Self::is_api_call.

pub fn response_body(&self) -> Option<&str>

Captured response body when Self::is_api_call.

Returned by HTTP transports that read the full body before raising the error; otherwise None.

pub fn url(&self) -> Option<&str>

Request URL when Self::is_api_call.

pub fn model_id(&self) -> Option<&str>

Model id when Self::is_no_such_model.

pub fn backtrace(&self) -> &Backtrace

Captured backtrace (empty unless RUST_BACKTRACE is set).

Trait Implementations

impl Debug for ProviderError

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

Formats the value using the given formatter.

impl Display for ProviderError

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

Formats the value using the given formatter.

impl Error for ProviderError

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.