Enum UploadError 

#[non_exhaustive]
pub enum UploadError {
    HeaderMissing {
        stream_empty: bool,
    },
    UnexpectedMessage {
        header: bool,
    },
    BadPackId {
        chunk: bool,
        len: Option<usize>,
    },
    PackIdMismatch,
    TotalMissing,
    TotalTooLarge {
        total: u64,
        cap: u64,
    },
    TooManyChunks,
    OffsetMissing,
    OffsetGap {
        offset: u64,
        expected: u64,
    },
    ByteCountOverflow,
    Overrun,
    AfterLast,
    NoLast,
    LengthMismatch {
        received: u64,
        declared: u64,
    },
    DigestMismatch,
}

Why an upload stream was rejected.

The stream-shape variants (Self::HeaderMissing, Self::UnexpectedMessage) and Self::DigestMismatch are raised by the binding, which decodes messages and owns the sink; the validator raises every other variant.

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.

HeaderMissing

The stream did not start with a header. stream_empty when it ended before any message.

Fields

stream_empty: bool

No message arrived at all.

UnexpectedMessage

A message after the header was not a chunk. header when it was a second header, otherwise a message with no body.

Fields

header: bool

The message was a second header.

BadPackId

A pack_id that is absent (len: None) or not 32 bytes long. chunk when it was a chunk’s rather than the header’s.

Fields

chunk: bool

The id came from a chunk.

len: Option<usize>

Its length, or None when absent.

PackIdMismatch

A chunk’s pack_id differs from the header’s.

TotalMissing

The header has no total_bytes.

TotalTooLarge

The declared total_bytes is over the binding’s cap.

Fields

total: u64

Declared size.

cap: u64

The binding’s cap.

TooManyChunks

More chunks than the binding’s cap arrived without last.

OffsetMissing

A chunk has no offset.

OffsetGap

A chunk’s offset is not the running byte count.

Fields

offset: u64

The chunk’s offset.

expected: u64

The running byte count.

ByteCountOverflow

The running byte count overflowed u64.

Overrun

The chunks carry more bytes than the header declared.

AfterLast

A chunk arrived after the last one.

NoLast

The stream ended without a last chunk.

LengthMismatch

The last chunk arrived before the declared byte count.

Fields

received: u64

Bytes received.

declared: u64

Bytes the header declared.

DigestMismatch

The received bytes do not hash to the header’s pack_id.

Implementations

impl UploadError

pub const fn code(self) -> Code

The Connect-side code: Code::ResourceExhausted for an oversized declared total, Code::InvalidArgument for everything else.

pub const fn ssh_message(self) -> &'static str

mkit serve’s message, verbatim. Every one is sent with ERROR_CODE_INVALID_REQUEST; the ssh binding maps codes itself.

pub fn connect_message(self) -> Cow<'static, str>

mkit-transport-connect’s message, verbatim. TotalMissing, OffsetMissing, TooManyChunks and AfterLast are new: that server reads an absent total_bytes or offset as 0, has no chunk cap and stops reading at last.

Trait Implementations

impl Clone for UploadError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UploadError

impl Debug for UploadError

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

Formats the value using the given formatter.

impl Eq for UploadError

impl From<UploadError> for ServerError

fn from(err: UploadError) -> Self

The Connect code and message.

impl PartialEq for UploadError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for UploadError