Enum FirebaseError

pub enum FirebaseError {
    Generic(&'static str),
    UnexpectedResponse(&'static str, StatusCode, String, String),
    APIError(usize, String, String),
    Request(Error),
    JWT(Error),
    JWTValidation(ValidationError),
    Ser {
        doc: Option<String>,
        ser: Error,
    },
    SerdeVerbose {
        doc: Option<String>,
        input_doc: String,
        ser: Error,
    },
    RSA(KeyRejected),
    IO(Error),
}

The main error type used throughout this crate. It wraps / converts from a few other error types and implements error::Error so that you can use it in any situation where the standard error type is expected.

Variants

Generic(&'static str)

Generic errors are very rarely used and only used if no other error type matches

UnexpectedResponse(&'static str, StatusCode, String, String)

If the http status code is != 200 and no Google error response is attached (see https://firebase.google.com/docs/reference/rest/auth#section-error-format) then this error type will be returned

APIError(usize, String, String)

An error returned by the Firestore API - Contains the numeric code, a string code and a context. If the APIError happened on a document query or mutation, the document path will be set as context. If the APIError happens on a user_* method, the user id will be set as context. For example: 400, CREDENTIAL_TOO_OLD_LOGIN_AGAIN

Request(Error)

An error caused by the http library. This only happens if the http request is badly formatted (too big, invalid characters) or if the server did strange things (connection abort, ssl verification error).

JWT(Error)

Should not happen. If jwt encoding / decoding fails or an value cannot be extracted or a jwt is badly formatted or corrupted

JWTValidation(ValidationError)

Ser

Serialisation failed

Fields

doc: Option<String>

ser: Error

SerdeVerbose

Verbose deserialization failure

Fields

doc: Option<String>

input_doc: String

ser: Error

RSA(KeyRejected)

When the credentials.json file contains an invalid private key this error is returned

IO(Error)

Disk access errors

Trait Implementations

impl Debug for FirebaseError

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

Formats the value using the given formatter.

impl Display for FirebaseError

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

Formats the value using the given formatter.

impl Error for FirebaseError

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 FirebaseError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for FirebaseError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for FirebaseError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for FirebaseError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<KeyRejected> for FirebaseError

fn from(error: KeyRejected) -> Self

Converts to this type from the input type.

impl From<ValidationError> for FirebaseError

fn from(error: ValidationError) -> Self

Converts to this type from the input type.