Trait reed_solomon_simd::rate::Rate

pub trait Rate<E: Engine> {
    type RateEncoder: RateEncoder<E>;
    type RateDecoder: RateDecoder<E>;

    // Required method
    fn supports(original_count: usize, recovery_count: usize) -> bool;

    // Provided methods
    fn encoder(
        original_count: usize,
        recovery_count: usize,
        shard_bytes: usize,
        engine: E,
        work: Option<EncoderWork>
    ) -> Result<Self::RateEncoder, Error> { ... }
    fn decoder(
        original_count: usize,
        recovery_count: usize,
        shard_bytes: usize,
        engine: E,
        work: Option<DecoderWork>
    ) -> Result<Self::RateDecoder, Error> { ... }
    fn validate(
        original_count: usize,
        recovery_count: usize,
        shard_bytes: usize
    ) -> Result<(), Error> { ... }
}

Reed-Solomon encoder/decoder generator using specific rate.

Required Associated Types

type RateEncoder: RateEncoder<E>

Encoder of this rate.

type RateDecoder: RateDecoder<E>

Decoder of this rate.

Required Methods

fn supports(original_count: usize, recovery_count: usize) -> bool

Returns true if given original_count / recovery_count combination is supported.

Provided Methods

fn encoder( original_count: usize, recovery_count: usize, shard_bytes: usize, engine: E, work: Option<EncoderWork> ) -> Result<Self::RateEncoder, Error>

Creates new encoder. This is same as RateEncoder::new.

fn decoder( original_count: usize, recovery_count: usize, shard_bytes: usize, engine: E, work: Option<DecoderWork> ) -> Result<Self::RateDecoder, Error>

Creates new decoder. This is same as RateDecoder::new.

fn validate( original_count: usize, recovery_count: usize, shard_bytes: usize ) -> Result<(), Error>

Returns Ok(()) if given original_count / recovery_count combination is supported and given shard_bytes is valid.

Object Safety

This trait is not object safe.

Implementors

impl<E: Engine> Rate<E> for DefaultRate<E>

type RateEncoder = DefaultRateEncoder<E>

type RateDecoder = DefaultRateDecoder<E>

impl<E: Engine> Rate<E> for HighRate<E>

type RateEncoder = HighRateEncoder<E>

type RateDecoder = HighRateDecoder<E>

impl<E: Engine> Rate<E> for LowRate<E>

type RateEncoder = LowRateEncoder<E>

type RateDecoder = LowRateDecoder<E>