Enum TranscodeContractError 

#[non_exhaustive]
pub enum TranscodeContractError {
    OverRead {
        read: usize,
        available: usize,
    },
    OverWritten {
        written: usize,
        available: usize,
    },
    ProgressIndexOverflow {
        index: usize,
        advanced: usize,
    },
    SatisfiedNeed {
        required: usize,
        available: usize,
    },
    CompleteWithRemainingInput {
        read: usize,
        available: usize,
    },
}

Error reported when a transcoder returns inconsistent progress.

This error represents a broken crate::Transcoder implementation rather than malformed input data. Buffered drivers call crate::TranscodeProgress::validate before trusting progress counters for unchecked buffer cursor movement.

Examples

use qubit_codec::TranscodeContractError;

let error = TranscodeContractError::OverRead { read: 2, available: 1 };
assert_eq!(error.to_string(), "transcoder consumed 2 units but only 1 were available");

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.

OverRead

The transcoder consumed more input units than the caller supplied.

Fields

read: usize

Input units reported as consumed.

available: usize

Input units available to the transcode call.

OverWritten

The transcoder wrote more output units than the caller supplied.

Fields

written: usize

Output units reported as written.

available: usize

Output slots available to the transcode call.

ProgressIndexOverflow

Progress could not be represented as an absolute index.

Fields

index: usize

Absolute index supplied to the transcode call.

advanced: usize

Relative progress reported by the transcoder.

SatisfiedNeed

A status requested input or output that is already available.

Fields

required: usize

Required units reported by the status.

available: usize

Available units reported by the status.

CompleteWithRemainingInput

A Complete status left visible input unconsumed.

Fields

read: usize

Input units reported as consumed.

available: usize

Input units available to the transcode call.

Trait Implementations

impl Clone for TranscodeContractError

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 TranscodeContractError

impl Debug for TranscodeContractError

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

Formats the value using the given formatter.

impl Display for TranscodeContractError

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

Formats the value using the given formatter.

impl Eq for TranscodeContractError

impl Error for TranscodeContractError

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<TranscodeContractError> for TranscodeFailure

fn from(error: TranscodeContractError) -> Self

Converts a broken transcoder progress report into a framework failure.

Parameters

• error: Progress-contract violation to retain as the error source.

Returns

Returns Self::InvalidProgress carrying the original violation.

impl Hash for TranscodeContractError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TranscodeContractError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TranscodeContractError