Enum StreamError 

#[non_exhaustive]
pub enum StreamError {
    Io(Error),
    BadMagic,
    UnsupportedVersion(u8),
    UnsupportedSuite(u8),
    ReservedFlags,
    ShortHeader,
    BadChunkSize(usize),
    ChunkTooLarge,
    SuiteMismatch {
        actual: u8,
    },
    BadPublicKey,
    BadCekLength,
    BadKemCiphertext,
    Truncated,
    AuthFailed,
    KdfFailed,
    SealFailed,
    CekRecovery(Error),
}

Errors produced by the streaming encrypt/decrypt API.

All authentication failures collapse to StreamError::AuthFailed so the caller learns nothing beyond “this stream did not verify”.

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.

Io(Error)

Underlying reader or writer I/O failed.

BadMagic

The container magic bytes did not match.

UnsupportedVersion(u8)

The container declared an unsupported format version.

UnsupportedSuite(u8)

The container declared an unknown algorithm suite.

ReservedFlags

The reserved header flags byte was non-zero.

ShortHeader

The header was shorter than the format requires.

BadChunkSize(usize)

The requested or declared chunk size was zero or above MAX_CHUNK_SIZE.

ChunkTooLarge

A record’s length prefix implied a plaintext chunk above the limit.

SuiteMismatch

The decrypt entry point was called for a different suite family than the container actually uses (e.g. AEAD decrypt on an ML-KEM stream).

Fields

actual: u8

The suite id found in the container header.

BadPublicKey

A supplied ML-KEM public encapsulation key was malformed.

BadCekLength

A supplied content-encryption key was not [CEK_LEN] bytes.

BadKemCiphertext

The ML-KEM ciphertext / encapsulated key was malformed.

Truncated

The stream ended before a final-marked chunk was authenticated.

AuthFailed

AEAD authentication failed: wrong key, tampered data/AAD, reordered or truncated chunk, or a downgraded header.

KdfFailed

HKDF key derivation failed.

SealFailed

AEAD sealing failed.

CekRecovery(Error)

Recovering the content-encryption key from the broker failed.

Trait Implementations

impl Debug for StreamError

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

Formats the value using the given formatter.

impl Display for StreamError

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

Formats the value using the given formatter.

impl Error for StreamError

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 StreamError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for StreamError

fn from(source: Error) -> Self

Converts to this type from the input type.