Enum reed_solomon_simd::Error

pub enum Error {
    DifferentShardSize {
        shard_bytes: usize,
        got: usize,
    },
    DuplicateOriginalShardIndex {
        index: usize,
    },
    DuplicateRecoveryShardIndex {
        index: usize,
    },
    InvalidOriginalShardIndex {
        original_count: usize,
        index: usize,
    },
    InvalidRecoveryShardIndex {
        recovery_count: usize,
        index: usize,
    },
    InvalidShardSize {
        shard_bytes: usize,
    },
    NotEnoughShards {
        original_count: usize,
        original_received_count: usize,
        recovery_received_count: usize,
    },
    TooFewOriginalShards {
        original_count: usize,
        original_received_count: usize,
    },
    TooManyOriginalShards {
        original_count: usize,
    },
    UnsupportedShardCount {
        original_count: usize,
        recovery_count: usize,
    },
}

Represents all possible errors that can occur in this library.

Variants

DifferentShardSize

Given shard has different size than given or inferred shard size.

• Shard size is given explicitly to encoders/decoders and inferred for reed_solomon_simd::encode and reed_solomon_simd::decode.

Fields

shard_bytes: usize

Given or inferred shard size.

got: usize

Size of the given shard.

DuplicateOriginalShardIndex

Decoder was given two original shards with same index.

Fields

index: usize

Given duplicate index.

DuplicateRecoveryShardIndex

Decoder was given two recovery shards with same index.

Fields

index: usize

Given duplicate index.

InvalidOriginalShardIndex

Decoder was given original shard with invalid index, i.e. index >= original_count.

Fields

original_count: usize

Configured number of original shards.

index: usize

Given invalid index.

InvalidRecoveryShardIndex

Decoder was given recovery shard with invalid index, i.e. index >= recovery_count.

Fields

recovery_count: usize

Configured number of recovery shards.

index: usize

Given invalid index.

InvalidShardSize

Given or inferred shard size is invalid: Size must be non-zero and multiple of 64 bytes.

• Shard size is given explicitly to encoders/decoders and inferred for reed_solomon_simd::encode and reed_solomon_simd::decode.

Fields

shard_bytes: usize

Given or inferred shard size.

NotEnoughShards

Decoder was given too few shards.

Decoding requires as many shards as there were original shards in total, in any combination of original shards and recovery shards.

Fields

original_count: usize

Configured number of original shards.

original_received_count: usize

Number of original shards given to decoder.

recovery_received_count: usize

Number of recovery shards given to decoder.

TooFewOriginalShards

Encoder was given less than original_count original shards.

Fields

original_count: usize

Configured number of original shards.

original_received_count: usize

Number of original shards given to encoder.

TooManyOriginalShards

Encoder was given more than original_count original shards.

Fields

original_count: usize

Configured number of original shards.

UnsupportedShardCount

Given original_count / recovery_count combination is not supported.

Fields

original_count: usize

Given number of original shards.

recovery_count: usize

Given number of recovery shards.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

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 PartialEq for Error

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Error

impl StructuralPartialEq for Error