Skip to main content

LrcCodec

fsqlite_core::lrc

Struct LrcCodec

pub struct LrcCodec { /* private fields */ }

Expand description

Local Reconstruction Codes codec.

Produces local parity symbols (one per locality group) plus a global parity symbol. Single failures within a group can be repaired locally.

Implementations§

impl LrcCodec

pub fn new(config: LrcConfig) -> Self

Create a new LRC codec with the given configuration.

pub fn locality(&self) -> usize

Return the locality group size.

pub fn encode(&self, source_data: &[u8], symbol_size: usize) -> LrcEncodeResult

Encode source data into source symbols + local/global parities.

source_data is split into symbol_size-byte symbols. Each locality group of r symbols gets a local parity (XOR). A global parity (XOR of all source symbols) is also computed.

pub fn repair( &self, encode_result: &LrcEncodeResult, available: &HashMap<u32, Vec<u8>>, missing: &[u32], ) -> Vec<LrcRepairOutcome>

Attempt to repair missing symbols using local and global parities.

available maps symbol index -> data for symbols that are present. missing lists the indices of symbols that need repair. Returns the repair outcome.

Trait Implementations§

impl Debug for LrcCodec

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for LrcCodec

impl RefUnwindSafe for LrcCodec

impl Send for LrcCodec

impl Sync for LrcCodec

impl Unpin for LrcCodec

impl UnsafeUnpin for LrcCodec

impl UnwindSafe for LrcCodec

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T> Instrument for T

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more