Enum EqlError 

pub enum EqlError {
    CiphertextCouldNotBeSerialised(Error),
    ColumnCouldNotBeParsed,
    ColumnIsNull,
    ColumnCouldNotBeDeserialised {
        table: String,
        column: String,
    },
    ColumnCouldNotBeEncrypted {
        table: String,
        column: String,
    },
    ColumnConfigurationMismatch {
        table: String,
        column: String,
    },
    CouldNotDecryptDataForKeyset {
        keyset_id: String,
    },
    InvalidIndexTerm,
    MissingCiphertext(Identifier),
    KeysetIdCouldNotBeParsed {
        id: String,
    },
    KeysetIdCouldNotBeSet,
    KeysetNameCouldNotBeSet,
    MissingEncryptConfiguration {
        plaintext_type: &'static str,
    },
    PlaintextCouldNotBeEncoded,
    Pipeline(EncryptionError),
    PlaintextCouldNotBeDecoded(TypeParseError),
    MissingKeysetIdentifier,
    UnexpectedSetKeyset,
    UnknownColumn {
        table: String,
        column: String,
    },
    UnknownKeysetIdentifier {
        keyset: String,
    },
    UnknownTable {
        table: String,
    },
    UnknownIndexTerm(Identifier),
    ZeroKMS(Error),
    RecordDecrypt(RecordDecryptError),
}

Errors that can occur during EQL encryption, decryption, and index operations.

This enum covers all error cases in the EQL system, including serialization failures, configuration mismatches, keyset management issues, and cryptographic operation errors.

Variants

CiphertextCouldNotBeSerialised(Error)

Failed to serialize ciphertext to JSON format.

ColumnCouldNotBeParsed

An encrypted column value could not be parsed from the database format.

ColumnIsNull

An encrypted column value was NULL when a value was expected.

ColumnCouldNotBeDeserialised

Failed to deserialize an encrypted column from the database.

Fields

table: String

column: String

ColumnCouldNotBeEncrypted

Failed to encrypt a column value.

Fields

table: String

column: String

ColumnConfigurationMismatch

The encryption configuration for a column doesn’t match the encrypted data.

Fields

table: String

column: String

CouldNotDecryptDataForKeyset

Decryption failed using the specified keyset.

Fields

keyset_id: String

InvalidIndexTerm

An index term was not of the expected type for the operation.

MissingCiphertext(Identifier)

The EQL payload is missing its ciphertext field.

This typically occurs when attempting to decrypt a query-mode payload, which only contains searchable encrypted metadata (SEM) terms.

KeysetIdCouldNotBeParsed

The keyset ID provided via SET CIPHERSTASH.KEYSET_ID is not a valid UUID.

Fields

id: String

KeysetIdCouldNotBeSet

Failed to set the keyset ID using SET CIPHERSTASH.KEYSET_ID.

KeysetNameCouldNotBeSet

Failed to set the keyset name using SET CIPHERSTASH.KEYSET_NAME.

MissingEncryptConfiguration

Missing encryption configuration for a specific column type.

This should be unreachable in practice.

Fields

plaintext_type: &'static str

PlaintextCouldNotBeEncoded

Failed to encode decrypted plaintext as the expected data type.

Pipeline(EncryptionError)

An error occurred in the encryption pipeline.

PlaintextCouldNotBeDecoded(TypeParseError)

Failed to decode plaintext from the expected type format.

MissingKeysetIdentifier

No keyset identifier was provided when one was required.

UnexpectedSetKeyset

Attempted to set a keyset when a default keyset is already configured.

UnknownColumn

The specified column has no encryption configuration.

Fields

table: String

column: String

UnknownKeysetIdentifier

The keyset name or ID is not found in the configured credentials.

Fields

keyset: String

UnknownTable

The specified table has no encryption configuration.

Fields

table: String

UnknownIndexTerm(Identifier)

An unknown or unsupported index term type was encountered for the column.

ZeroKMS(Error)

A ZeroKMS error

RecordDecrypt(RecordDecryptError)

A record decryption error

Trait Implementations

impl Debug for EqlError

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

Formats the value using the given formatter.

impl Display for EqlError

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

Formats the value using the given formatter.

impl Error for EqlError

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<EncryptionError> for EqlError

fn from(source: EncryptionError) -> Self

Converts to this type from the input type.

impl From<Error> for EqlError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for EqlError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<RecordDecryptError> for EqlError

fn from(source: RecordDecryptError) -> Self

Converts to this type from the input type.

impl From<TypeParseError> for EqlError

fn from(source: TypeParseError) -> Self

Converts to this type from the input type.