Struct FirestoreErrorInTransaction

pub struct FirestoreErrorInTransaction {
    pub transaction_id: FirestoreTransactionId,
    pub source: Box<dyn Error + Send + Sync>,
}

Represents an error that occurred within the scope of a Firestore transaction.

This struct captures errors that happen during the execution of user-provided code within a transaction block, or errors from Firestore related to the transaction itself.

Fields

transaction_id: FirestoreTransactionId

The ID of the transaction in which the error occurred.

source: Box<dyn Error + Send + Sync>

The underlying error that caused the transaction to fail.

Implementations

impl FirestoreErrorInTransaction

pub fn new( transaction_id: FirestoreTransactionId, source: Box<dyn Error + Send + Sync>, ) -> Self

pub fn transaction_id(&mut self, value: FirestoreTransactionId) -> &mut Self

pub fn with_transaction_id(self, value: FirestoreTransactionId) -> Self

pub fn source(&mut self, value: Box<dyn Error + Send + Sync>) -> &mut Self

pub fn with_source(self, value: Box<dyn Error + Send + Sync>) -> Self

impl FirestoreErrorInTransaction

pub fn permanent<E: Error + Send + Sync + 'static>( transaction: &FirestoreTransaction<'_>, source: E, ) -> BackoffError<FirestoreError>

Wraps an error as a permanent BackoffError within a transaction context.

Permanent errors are those that are unlikely to be resolved by retrying the transaction (e.g., data validation errors in user code).

pub fn transient<E: Error + Send + Sync + 'static>( transaction: &FirestoreTransaction<'_>, source: E, ) -> BackoffError<FirestoreError>

Wraps an error as a transient BackoffError within a transaction context.

Transient errors are those that might be resolved by retrying the transaction (e.g., temporary network issues, concurrent modification conflicts).

pub fn retry_after<E: Error + Send + Sync + 'static>( transaction: &FirestoreTransaction<'_>, source: E, retry_after: Duration, ) -> BackoffError<FirestoreError>

Wraps an error as a BackoffError that should be retried after a specific duration.

Trait Implementations

impl Debug for FirestoreErrorInTransaction

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

Formats the value using the given formatter.

impl Display for FirestoreErrorInTransaction

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

Formats the value using the given formatter.

impl Error for FirestoreErrorInTransaction

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<FirestoreErrorInTransactionInit> for FirestoreErrorInTransaction

fn from(value: FirestoreErrorInTransactionInit) -> Self

Converts to this type from the input type.