Enum Error 

pub enum Error {
    MissingAuthToken,
    InvalidToken,
    AuthenticationFailed {
        message: String,
    },
    SessionError {
        message: String,
    },
    InvalidReference {
        reference: String,
        reason: String,
    },
    SecretNotFound {
        reference: String,
    },
    AccessDenied {
        vault: String,
    },
    NetworkError {
        message: String,
    },
    SdkError {
        message: String,
    },
    LibraryLoadError {
        message: String,
    },
    JsonError {
        message: String,
    },
}

Errors that can occur when using the 1Password client.

Error messages are designed to be helpful for debugging while ensuring that sensitive data (tokens, secret values) is never exposed.

Variants

MissingAuthToken

The OP_SERVICE_ACCOUNT_TOKEN environment variable is not set and no explicit token was provided via from_token().

InvalidToken

The provided token has an invalid format.

AuthenticationFailed

Authentication with 1Password failed. This typically means the token is expired or revoked.

Fields

message: String

A message describing the authentication failure (never contains the token).

SessionError

Failed to establish or maintain the SDK session.

Fields

message: String

A message describing the session error.

InvalidReference

The secret reference format is invalid.

Valid format: op://vault/item/field or op://vault/item/section/field

Fields

reference: String

The invalid reference string (safe to display, contains no secrets).

reason: String

The reason the reference is invalid.

SecretNotFound

The requested secret was not found in 1Password.

Fields

reference: String

The reference that was not found.

AccessDenied

Access to the specified vault was denied. This typically means the service account lacks permission for this vault.

Fields

vault: String

The vault name that access was denied to.

NetworkError

A network error occurred while communicating with 1Password.

Fields

message: String

A message describing the network error.

SdkError

An error occurred in the underlying 1Password SDK.

Fields

message: String

A message describing the SDK error.

LibraryLoadError

Failed to load the native 1Password library.

Fields

message: String

A message describing the library loading error.

JsonError

JSON serialization or deserialization error.

Fields

message: String

A message describing the JSON error.

Implementations

impl Error

pub fn is_retriable(&self) -> bool

Check if this error is retriable (e.g., transient network issues).

pub fn is_auth_error(&self) -> bool

Check if this error indicates an authentication problem.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.