Trait reed_solomon_16::rate::RateEncoder

pub trait RateEncoder<E: Engine> where
    Self: Sized, {
    type Rate: Rate<E>;
    fn add_original_shard<T: AsRef<[u8]>>(
        &mut self, 
        original_shard: T
    ) -> Result<(), Error>;
    fn encode(&mut self) -> Result<EncoderResult<'_>, Error>;
    fn into_parts(self) -> (E, EncoderWork);
    fn new(
        original_count: usize, 
        recovery_count: usize, 
        shard_bytes: usize, 
        engine: E, 
        work: Option<EncoderWork>
    ) -> Result<Self, Error>;
    fn reset(
        &mut self, 
        original_count: usize, 
        recovery_count: usize, 
        shard_bytes: usize
    ) -> Result<(), Error>;

    fn supports(original_count: usize, recovery_count: usize) -> bool { ... }
    fn validate(
        original_count: usize, 
        recovery_count: usize, 
        shard_bytes: usize
    ) -> Result<(), Error> { ... }
}

Reed-Solomon encoder using specific rate.

Associated Types

type Rate: Rate<E>

Rate of this encoder.

Required methods

fn add_original_shard<T: AsRef<[u8]>>(
    &mut self,
    original_shard: T
) -> Result<(), Error>

Like ReedSolomonEncoder::add_original_shard.

fn encode(&mut self) -> Result<EncoderResult<'_>, Error>

Like ReedSolomonEncoder::encode.

fn into_parts(self) -> (E, EncoderWork)

Consumes this encoder returning its Engine and EncoderWork so that they can be re-used by another encoder.

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

Like ReedSolomonEncoder::new with Engine to use and optional working space to be re-used.

fn reset(
    &mut self,
    original_count: usize,
    recovery_count: usize,
    shard_bytes: usize
) -> Result<(), Error>

Like ReedSolomonEncoder::reset.

Provided methods

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

Returns true if given original_count / recovery_count combination is supported.

This is same as Rate::supports.

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.

This is same as Rate::validate.

Implementors

impl<E: Engine> RateEncoder<E> for DefaultRateEncoder<E>

type Rate = DefaultRate<E>

impl<E: Engine> RateEncoder<E> for HighRateEncoder<E>

type Rate = HighRate<E>

impl<E: Engine> RateEncoder<E> for LowRateEncoder<E>

type Rate = LowRate<E>