Enum RetryReason 

#[non_exhaustive]
pub enum RetryReason {
    KvNotMyVbucket,
    KvInvalidVbucketMap,
    KvTemporaryFailure,
    KvCollectionOutdated,
    KvErrorMapRetryIndicated,
    KvLocked,
    KvSyncWriteInProgress,
    KvSyncWriteRecommitInProgress,
    ServiceNotAvailable,
    SocketClosedWhileInFlight,
    SocketNotAvailable,
    QueryPreparedStatementFailure,
    QueryIndexNotFound,
    SearchTooManyRequests,
    HttpSendRequestFailed,
    HttpConnectFailed,
    NotReady,
}

The reason an operation is being retried.

Each variant identifies a specific transient failure condition that triggered a retry. The SDK passes this to RetryStrategy::retry_after so the strategy can decide whether (and how long) to wait before retrying.

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.

KvNotMyVbucket

The server indicated the vBucket is not owned by this node.

KvInvalidVbucketMap

The vBucket map is invalid and must be refreshed.

KvTemporaryFailure

A temporary failure occurred on the KV engine.

KvCollectionOutdated

The collection ID is outdated and must be re-resolved.

KvErrorMapRetryIndicated

The server error map indicated the operation should be retried.

KvLocked

The document is locked by another operation.

KvSyncWriteInProgress

A sync-write (durable operation) is already in progress on this key.

KvSyncWriteRecommitInProgress

A sync-write recommit is in progress on this key.

ServiceNotAvailable

The required service is temporarily unavailable.

SocketClosedWhileInFlight

The connection was closed while the request was in flight.

SocketNotAvailable

No connection is currently available.

QueryPreparedStatementFailure

A prepared statement for the query was invalidated.

QueryIndexNotFound

The query index was not found (may still be building).

SearchTooManyRequests

The search service is rejecting requests due to rate limiting.

HttpSendRequestFailed

An HTTP request failed to send.

HttpConnectFailed

An HTTP connection failed to be established.

NotReady

The SDK is not yet ready to perform the operation.

Implementations

impl RetryReason

pub fn allows_non_idempotent_retry(&self) -> bool

Returns true if this reason allows retrying non-idempotent operations.

Most retry reasons are safe for non-idempotent retries because the server never processed the original request.

pub fn always_retry(&self) -> bool

Returns true if the SDK should always retry for this reason, regardless of the retry strategy’s decision.

Trait Implementations

impl Clone for RetryReason

fn clone(&self) -> RetryReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetryReason

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

Formats the value using the given formatter.

impl Display for RetryReason

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

Formats the value using the given formatter.

impl Hash for RetryReason

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RetryReason

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RetryReason

impl Eq for RetryReason

impl StructuralPartialEq for RetryReason