Struct ClientApiError 

pub struct ClientApiError {
    pub code: ClientErrorCode,
    pub message: String,
    pub details: Option<Value>,
}

Error returned when a license server API call fails.

This wraps the server’s error response and provides convenient access to the error code for programmatic handling.

Fields

code: ClientErrorCode

Machine-readable error code

message: String

Human-readable error message from server

details: Option<Value>

Optional additional details (e.g., field name for validation errors)

Implementations

impl ClientApiError

pub fn new(code: ClientErrorCode, message: impl Into<String>) -> Self

Create a new client API error.

pub fn with_details( code: ClientErrorCode, message: impl Into<String>, details: Value, ) -> Self

Create a new client API error with details.

pub fn grace_period_expired() -> Self

Create an error for grace period expiration (client-side only).

pub fn is_license_invalid(&self) -> bool

Returns true if this error indicates the license is invalid.

pub fn requires_online(&self) -> bool

Returns true if this error might be resolved by going online.

Trait Implementations

impl Clone for ClientApiError

fn clone(&self) -> ClientApiError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientApiError

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

Formats the value using the given formatter.

impl Display for ClientApiError

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

Formats the value using the given formatter.

impl Error for ClientApiError

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 From<ServerErrorResponse> for ClientApiError

fn from(resp: ServerErrorResponse) -> Self

Converts to this type from the input type.