Enum sodoken::SodokenError

#[non_exhaustive]
pub enum SodokenError {
    AllocationFailed,
    BadHashSize,
    BadSaltSize,
    BadKeySize,
    BadPublicKeySize,
    BadSecretKeySize,
    BadSignatureSize,
    BadSeedSize,
    BadCipherSize,
    BadNonceSize,
    BadMessageSize,
    BadPassphraseSize,
    BadOpsLimit,
    BadMemLimit,
    WriteOverflow,
    InternalSodium,
    Other(Box<dyn Error + Send + Sync>),
}

Error type for holochain_crypto.

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.

AllocationFailed

we were unable to allocate memory

BadHashSize

the output hash size for this call didn’t fall within constraints

BadSaltSize

the salt size for this call didn’t fall within constraints

BadKeySize

the key size for this call didn’t fall within constraints

BadPublicKeySize

the public key size for this call didn’t fall within constraints

BadSecretKeySize

the secret key size for this call didn’t fall within constraints

BadSignatureSize

improper size for signature

BadSeedSize

improper size for seed

BadCipherSize

improper size for cipher

BadNonceSize

improper size for nonce

BadMessageSize

improper size for message

BadPassphraseSize

the passphrase size for this call didn’t fall within constraints

BadOpsLimit

the ops limit for this call didn’t fall within constraints

BadMemLimit

the mem limit for this call didn’t fall within constraints

WriteOverflow

bad bounds for write operation

InternalSodium

Internal libsodium error

Other(Box<dyn Error + Send + Sync>)

generic internal error

Implementations

impl SodokenError

pub fn other(e: impl Into<Box<dyn Error + Send + Sync>>) -> Self

Build an “Other” type SodokenError.

Trait Implementations

impl Debug for SodokenError

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

Formats the value using the given formatter.

impl Display for SodokenError

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

Formats the value using the given formatter.

impl Error for SodokenError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<&'_ str> for SodokenError

fn from(s: &str) -> Self

Performs the conversion.

impl From<SodokenError> for ()

fn from(_: SodokenError)

Performs the conversion.

impl From<String> for SodokenError

fn from(s: String) -> Self

Performs the conversion.