Enum GenerateError 

pub enum GenerateError {
    Entropy(String),
    PayloadTooLarge {
        payload: usize,
        available: usize,
        deficit: usize,
        recommended_side: Option<u32>,
    },
    DimensionsOutOfRange {
        width: u32,
        height: u32,
        min_side: u32,
        max_pixels: u64,
    },
    NoUsableTexture {
        candidates: u32,
    },
    Sampling(RejectionExhausted),
    Kdf(KdfError),
    Expand(ExpandError),
    Crypto(CryptoError),
    Output(OutputError),
}

Everything that can go wrong between a plaintext and a generated container.

Variants

Entropy(String)

The system random number generator could not be read.

Fatal rather than papered over: every alternative source of a seed is one an adversary can reproduce, and a container generated from a guessable seed is one they can regenerate and compare against.

PayloadTooLarge

The compressed payload is larger than the requested container can hold.

Fields

payload: usize

Payload bytes after compression.

available: usize

Compressed payload bytes the requested container admits.

deficit: usize

How far over the limit the payload is, in bytes.

recommended_side: Option<u32>

Side of the smallest square container that would admit this payload, rounded up to a round figure for quoting to a user, or None when no permitted container is large enough. A caller with a size to suggest reads it from here rather than solving the quadratic itself.

DimensionsOutOfRange

The requested container size is outside the permitted range.

Fields

width: u32

Requested width, in pixels.

height: u32

Requested height, in pixels.

min_side: u32

Smallest side either dimension may have.

max_pixels: u64

Largest pixel count the two may multiply to.

NoUsableTexture

No candidate texture passed the container gates.

Fields

candidates: u32

Seeds that were tried.

Sampling(RejectionExhausted)

Conditioned sampling could not reach a parity.

Kdf(KdfError)

Argon2id password stretching failed.

Expand(ExpandError)

HKDF-SHA3-512 expansion of the master key failed.

Crypto(CryptoError)

Compression or encryption failed.

Output(OutputError)

The container could not be written to disk.

Trait Implementations

impl Debug for GenerateError

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

Formats the value using the given formatter.

impl Display for GenerateError

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

Formats the value using the given formatter.

impl Error for GenerateError

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<AEADError> for GenerateError

fn from(err: AEADError) -> Self

Converts to this type from the input type.

impl From<CryptoError> for GenerateError

fn from(err: CryptoError) -> Self

Converts to this type from the input type.

impl From<ExpandError> for GenerateError

fn from(err: ExpandError) -> Self

Converts to this type from the input type.

impl From<KdfError> for GenerateError

fn from(err: KdfError) -> Self

Converts to this type from the input type.

impl From<OutputError> for GenerateError

fn from(err: OutputError) -> Self

Converts to this type from the input type.

impl From<RejectionExhausted> for GenerateError

fn from(err: RejectionExhausted) -> Self

Converts to this type from the input type.