Enum FirestoreError

pub enum FirestoreError {
    SystemError(FirestoreSystemError),
    DatabaseError(FirestoreDatabaseError),
    DataConflictError(FirestoreDataConflictError),
    DataNotFoundError(FirestoreDataNotFoundError),
    InvalidParametersError(FirestoreInvalidParametersError),
    SerializeError(FirestoreSerializationError),
    DeserializeError(FirestoreSerializationError),
    NetworkError(FirestoreNetworkError),
    ErrorInTransaction(FirestoreErrorInTransaction),
    CacheError(FirestoreCacheError),
}

The main error type for all Firestore operations.

This enum consolidates various specific error types that can occur during interactions with Google Firestore.

Variants

SystemError(FirestoreSystemError)

An error originating from the underlying system or a dependency, not directly from a Firestore API interaction. This could include issues with the gRPC client, I/O errors, etc.

DatabaseError(FirestoreDatabaseError)

A general error reported by the Firestore database. This often wraps errors returned by the Firestore gRPC API.

DataConflictError(FirestoreDataConflictError)

An error indicating a data conflict, such as trying to create a document that already exists, or an optimistic locking failure.

DataNotFoundError(FirestoreDataNotFoundError)

An error indicating that the requested data (e.g., a document or collection) was not found.

InvalidParametersError(FirestoreInvalidParametersError)

An error due to invalid parameters provided by the client for an operation.

SerializeError(FirestoreSerializationError)

An error that occurred during the serialization of data to be sent to Firestore.

DeserializeError(FirestoreSerializationError)

An error that occurred during the deserialization of data received from Firestore.

NetworkError(FirestoreNetworkError)

An error related to network connectivity or communication with the Firestore service.

ErrorInTransaction(FirestoreErrorInTransaction)

An error that occurred specifically within the context of a Firestore transaction.

CacheError(FirestoreCacheError)

An error related to the caching layer, if enabled and used.

Trait Implementations

impl Debug for FirestoreError

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

Formats the value using the given formatter.

impl Display for FirestoreError

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

Formats the value using the given formatter.

impl Error for FirestoreError

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

fn custom<T>(msg: T) -> Self

where T: Display,

Used when a Serialize implementation encounters any error while serializing a type.

impl Error for FirestoreError

fn custom<T>(msg: T) -> Self

where T: Display,

Raised when there is general error when deserializing a type.

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl From<Error> for FirestoreError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for FirestoreError

fn from(io_error: Error) -> Self

Converts to this type from the input type.

impl From<OutOfRangeError> for FirestoreError

fn from(out_of_range: OutOfRangeError) -> Self

Converts to this type from the input type.

impl From<ParseError> for FirestoreError

fn from(parse_err: ParseError) -> Self

Converts to this type from the input type.

impl From<SendError<WriteRequest>> for FirestoreError

fn from(send_error: SendError<WriteRequest>) -> Self

Converts to this type from the input type.

impl From<Status> for FirestoreError

fn from(status: Status) -> Self

Converts to this type from the input type.