Enum Error

pub enum Error {
    SchemaMismatch {
        database_name: String,
        schema: SchemaName,
        stored_schema: SchemaName,
    },
    SchemaAlreadyRegistered(SchemaName),
    SchemaNotRegistered(SchemaName),
    ViewAlreadyRegistered(ViewName),
    InvalidDatabaseName(String),
    DatabaseNotFound(String),
    ViewNotFound,
    CollectionNotFound,
    ApiNotFound(ApiName),
    DatabaseNameAlreadyTaken(String),
    Networking(Error),
    CollectionAlreadyDefined,
    DocumentNotFound(CollectionName, Box<DocumentId>),
    DocumentIdTooLong,
    DocumentConflict(CollectionName, Box<Header>),
    UniqueKeyViolation {
        view: ViewName,
        conflicting_document: Box<Header>,
        existing_document: Box<Header>,
    },
    DocumentPush(CollectionName, NextValueError),
    InvalidName(InvalidNameError),
    PermissionDenied(PermissionDenied),
    Password(String),
    UserNotFound,
    InvalidUnicode(String),
    InvalidCredentials,
    ReduceUnimplemented,
    NotANumber,
    Time(TimeError),
    Other {
        origin: String,
        error: String,
    },
}

an enumeration of errors that this crate can produce

Variants

SchemaMismatch

The database named database_name was created with a different schema (stored_schema) than provided (schema).

Fields

database_name: String

The name of the database being accessed.

schema: SchemaName

The schema provided for the database.

stored_schema: SchemaName

The schema stored for the database.

SchemaAlreadyRegistered(SchemaName)

The SchemaName returned has already been registered.

SchemaNotRegistered(SchemaName)

The SchemaName requested was not registered.

ViewAlreadyRegistered(ViewName)

The ViewName returned has already been registered.

InvalidDatabaseName(String)

An invalid database name was specified. See StorageConnection::create_database() for database name requirements.

DatabaseNotFound(String)

The database name given was not found.

ViewNotFound

The view was not found.

CollectionNotFound

The collection was not found.

ApiNotFound(ApiName)

The api invoked was not found.

DatabaseNameAlreadyTaken(String)

The database name already exists.

Networking(Error)

An error occurred from networking.

CollectionAlreadyDefined

A Collection being added already exists. This can be caused by a collection name not being unique.

DocumentNotFound(CollectionName, Box<DocumentId>)

An attempt to update a document that doesn’t exist.

DocumentIdTooLong

A value provided as a DocumentId exceeded DocumentId::MAX_LENGTH.

DocumentConflict(CollectionName, Box<Header>)

When updating a document, if a situation is detected where the contents have changed on the server since the Revision provided, a Conflict error will be returned.

UniqueKeyViolation

When saving a document in a collection with unique views, a document emits a key that is already emitted by an existing ocument, this error is returned.

Fields

view: ViewName

The name of the view that the unique key violation occurred.

conflicting_document: Box<Header>

The document that caused the violation.

existing_document: Box<Header>

The document that already uses the same key.

DocumentPush(CollectionName, NextValueError)

When pushing a document, an error occurred while generating the next unique id.

InvalidName(InvalidNameError)

An invalid name was specified during schema creation.

PermissionDenied(PermissionDenied)

Permission was denied.

Password(String)

An internal error handling passwords was encountered.

UserNotFound

The user specified was not found. This will not be returned in response to an invalid username being used during login. It will be returned in other APIs that operate upon users.

InvalidUnicode(String)

An error occurred converting from bytes to Utf-8.

InvalidCredentials

The credentials specified are not valid.

ReduceUnimplemented

Returned when the a view’s reduce() function is unimplemented.

NotANumber

A floating point operation yielded Not a Number.

Time(TimeError)

An error while operating with a time

Other

An error from another crate.

Fields

origin: String

The origin of the error.

error: String

The error message.

Implementations

impl Error

pub fn other(origin: impl Display, error: impl Display) -> Self

Returns an instance of Self::Other with the given parameters.

pub fn is_unique_key_error<View: View, C: HasSchema>( &self, connection: &C, ) -> bool

Returns true if this error is a Error::UniqueKeyViolation from View.

pub fn conflicting_document<Collection: Collection>(&self) -> Option<Header>

Returns the header of the conflicting document if this error is a Error::DocumentConflict from Collection.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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(source: 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.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.

impl<T> From<InsertError<T>> for Error

fn from(err: InsertError<T>) -> Self

Converts to this type from the input type.

impl From<InvalidHexadecimal> for Error

fn from(err: InvalidHexadecimal) -> Self

Converts to this type from the input type.

impl From<InvalidNameError> for Error

fn from(source: InvalidNameError) -> Self

Converts to this type from the input type.

impl From<PermissionDenied> for Error

fn from(source: PermissionDenied) -> Self

Converts to this type from the input type.

impl From<TimeError> for Error

fn from(source: TimeError) -> Self

Converts to this type from the input type.

impl Serialize for Error

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.