Enum meilisearch_sdk::errors::ErrorCode

#[non_exhaustive]
pub enum ErrorCode {
    IndexCreationFailed,
    IndexAlreadyExists,
    IndexNotFound,
    InvalidIndexUid,
    IndexNotAccessible,
    InvalidState,
    MissingPrimaryKey,
    PrimaryKeyAlreadyPresent,
    MaxFieldsLimitExceeded,
    MissingDocumentId,
    InvalidFacet,
    InvalidFilter,
    BadParameter,
    BadRequest,
    DocumentNotFound,
    InternalError,
    InvalidToken,
    Maintenance,
    MissingAuthorizationHeader,
    NotFound,
    PayloadTooLarge,
    UnretrievableDocument,
    SearchError,
    UnsupportedMediaType,
    DumpAlreadyInProgress,
    DumpProcessFailed,
    Unknown(UnknownErrorCode),
}

The error code.

Officially documented at https://docs.meilisearch.com/errors.

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.

IndexCreationFailed

An error occurred while trying to create an index.

IndexAlreadyExists

An index with this UID already exists. You may want to use the get_or_create method.

IndexNotFound

No index was found with that UID. You may want to use the get_or_create method.

InvalidIndexUid

There was an error in the provided index format. Index UIDs can only be composed of alphanumeric characters, hyphens (-), and underscores (_).

IndexNotAccessible

An internal error occurred while trying to access the requested index.

InvalidState

The database is in an invalid state. Deleting the database and re-indexing should solve the problem.

MissingPrimaryKey

MeiliSearch couldn’t infer the primary key for the given documents. Consider specifying the key manually.

PrimaryKeyAlreadyPresent

The index already has a set primary key which can’t be changed.

MaxFieldsLimitExceeded

A document was added with more than 65,535 fields.

MissingDocumentId

A document is missing its primary key.

InvalidFacet

The facet provided with the search was invalid.

InvalidFilter

The filter provided with the search was invalid.

BadParameter

The request contains invalid parameters, check the error message for more information.

BadRequest

The request is invalid, check the error message for more information.

DocumentNotFound

The requested document can’t be retrieved. Either it doesn’t exist, or the database was left in an inconsistent state.

InternalError

MeiliSearch experienced an internal error. Check the error message and open an issue if necessary.

InvalidToken

The provided token is invalid.

Maintenance

The MeiliSearch instance is under maintenance.

MissingAuthorizationHeader

The requested resources are protected with an API key, which was not provided in the request header.

NotFound

The requested resources could not be found.

PayloadTooLarge

The payload sent to the server was too large.

UnretrievableDocument

The document exists in store, but there was an error retrieving it. This is likely caused by an inconsistent state in the database.

SearchError

There was an error in the search.

UnsupportedMediaType

The payload content type is not supported by MeiliSearch. Currently, MeiliSearch only supports JSON payloads.

DumpAlreadyInProgress

A dump creation is already in progress and a new one can’t be triggered until the previous dump creation is not finished.

DumpProcessFailed

An error occured during dump creation process, task aborted.

Unknown(UnknownErrorCode)

That’s unexpected. Please open a GitHub issue after ensuring you are using the supported version of the MeiliSearch server.

Implementations

impl ErrorCode

pub fn as_str(&self) -> &str

Converts the error code to the string representation returned by MeiliSearch.

pub fn parse(input: &str) -> Self

Converts the error code string returned by MeiliSearch into an ErrorCode enum. If the error type input is not recognized, ErrorCode::Unknown is returned.

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl Display for ErrorCode

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

Formats the value using the given formatter.