Struct ecpool::replica::ReplicaCoder

pub struct ReplicaCoder { /* fields omitted */ }

An ErasureCode implementation that simply replicates the input data.

Note that this is provided for example and testing purposes only and not intended to use in production.

Examples

use ecpool::{ErasureCode, ErrorKind};
use ecpool::replica::ReplicaCoder;
use std::num::NonZeroUsize;

let data_fragments = NonZeroUsize::new(4).ok_or("invalid input")?;
let parity_fragments = NonZeroUsize::new(2).ok_or("invalid input")?;
let mut coder = ReplicaCoder::new(data_fragments, parity_fragments);

// Encodes
let data = vec![0, 1, 2, 3];
let encoded = coder.encode(&data)?;
let encoded = encoded.iter().map(|f| f.as_ref()).collect::<Vec<_>>();

// Decodes
assert_eq!(Some(&data), coder.decode(&encoded[0..]).as_ref().ok());
assert_eq!(Some(&data), coder.decode(&encoded[1..]).as_ref().ok());
assert_eq!(Some(&data), coder.decode(&encoded[2..]).as_ref().ok());
assert_eq!(Err(ErrorKind::InvalidInput), coder.decode(&encoded[3..]).map_err(|e| *e.kind()));

Methods

impl ReplicaCoder

pub fn new(data_fragments: NonZeroUsize, parity_fragments: NonZeroUsize) -> Self

Makes a new ReplicaCoder instance.

Trait Implementations

impl Debug for ReplicaCoder

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

Formats the value using the given formatter.

impl Clone for ReplicaCoder

fn clone(&self) -> ReplicaCoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ErasureCode for ReplicaCoder

fn data_fragments(&self) -> NonZeroUsize

Returns the number of data fragments that the instance uses when encoding/decoding data.

fn parity_fragments(&self) -> NonZeroUsize

Returns the number of parity fragments that the instance uses when encoding/decoding data.

fn encode(&mut self, data: &[u8]) -> Result<Vec<FragmentBuf>>

Encodes the given data to fragments.

fn decode(&mut self, fragments: &[&Fragment]) -> Result<Vec<u8>>

Decodes the original data from the given fragments.

fn fragments(&self) -> NonZeroUsize

The total number of data fragments and parity fragments of the instance.

fn reconstruct(     &mut self,     index: usize,     fragments: &[&Fragment] ) -> Result<Vec<u8>>

Reconstructs the fragment specified by the given index from other fragments.

impl BuildCoder for ReplicaCoder

type Coder = Self

The type of ErasureCode implementaion to be built.

fn build_coder(&self) -> Result<Self::Coder>

Builds an instance of the ErasureCode implementaion.

fn coder_id(&self) -> String

Returns the identifier that distinguishes the kind of instances to be built.