Struct isa_l_erasure_coder::ErasureCoder

pub struct ErasureCoder { /* fields omitted */ }

Implementations

impl ErasureCoder

#[must_use]pub const fn k(&self) -> usize

#[must_use]pub const fn p(&self) -> usize

#[must_use]pub const fn m(&self) -> usize

#[must_use]pub fn encode_matrix(&self) -> &[u8]

#[must_use]pub fn new(k: usize, p: usize) -> Self

#[must_use]pub fn new_with_encode_matrix(
    k: usize,
    p: usize,
    encode_matrix: Vec<u8>
) -> Self

pub fn encode<T, M>(&self, data: impl AsRef<[T]>, bufs: impl AsMut<[M]>) where
    T: AsRef<[u8]>,
    M: AsMut<[u8]>, 

Calculate the parities over k data slices of data and place it into p buffer slices.

The length of all data slices and all buffer slices must be equal.

Panics

Panics if the length of data is not equal to k or if the length of bufs is not equal to p.

pub fn decode<T: AsRef<[u8]>, M: AsMut<[u8]>>(
    &self,
    blocks: &[T],
    erased_idxs: &[usize],
    bufs: impl AsMut<[M]>
) -> Result<(), ErrorKind>

Decode erased blocks given their indexes and the available blocks

Uses gf_gen_decode_matrix_simple from the isa-l crate.

Errors

This function will return an error if the number of provided blocks is smaller than k or if no decode matrix can be found.

pub fn decode_with_fn<'a, T: AsRef<[u8]>, M: AsMut<[u8]>>(
    &'a self,
    blocks: &[T],
    erased_idxs: &'a [usize],
    gen_decode_matrix: fn(_: &'a [u8], _: &'a [usize], _: usize, _: usize) -> Option<Vec<u8>>,
    bufs: impl AsMut<[M]>
) -> Result<(), ErrorKind>

Decode erased blocks given their indexes and the available blocks

Uses a custom function to generate a decode matrix with the signature:

fn gf_gen_decode_matrix_simple(
    encode_matrix: &[u8],
    erased_idxs: &[usize],
    k: usize,
    m: usize,
) -> Option<Vec<u8>>;

Errors

This function will return an error if the number of provided blocks is smaller than k or if no decode matrix can be found.

Trait Implementations

impl Debug for ErasureCoder

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

Formats the value using the given formatter.