Skip to main content

RsCode

Struct RsCode 

Source
pub struct RsCode { /* private fields */ }
Expand description

A systematic Cauchy Reed-Solomon erasure code: k data shards plus r parity shards, recovering any k of the k + r.

Implementations§

Source§

impl RsCode

Source

pub fn new(k: usize, r: usize) -> Result<Self, FecError>

Build a (k, r) systematic Cauchy-RS code. k >= 1, r >= 1, k + r <= 256.

Source

pub fn with_backend(self, backend: Option<GfBackend>) -> Self

Pin the GF(256) backend for this code (an A/B-bench / emulation- validation knob), or None to use the auto-detected fastest rung. The override is per-instance, so it never affects another RsCode.

Source

pub fn k(&self) -> usize

Number of data shards.

Source

pub fn r(&self) -> usize

Number of parity shards.

Source

pub fn encode( &self, data: &[&[u8]], parity: &mut [&mut [u8]], ) -> Result<(), FecError>

Compute the r parity shards from the k data shards. All shards (data and parity) must have the same length.

Source

pub fn decode(&self, shards: &mut [Option<Vec<u8>>]) -> Result<(), FecError>

Recover the missing data shards in place. shards has k + r entries (data shards first, then parity); Some = received, None = lost. On success every data-shard slot 0..k is Some. Returns TooFewShards if fewer than k survived.

Trait Implementations§

Source§

impl Clone for RsCode

Source§

fn clone(&self) -> RsCode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RsCode

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.