Struct CodedSymbol 

pub struct CodedSymbol<T: Symbol> {
    pub sum: Vec<u8>,
    pub hash: u64,
    pub count: i64,
    /* private fields */
}

A RIBLT is an infinite sequence of CodedSymbols

The ‘sum’ field is the XOR of the symbols encoded into this CodedSymbol

The ‘hash’ field is the XOR of the hashes of the symbols encoded into this CodedSymbol

The ‘count’ field is the number of local symbols minus the number of remote symbols

The ‘_marker’ phantom field is used to allow us to associate the CodedSymbol with a specific Symbol type. The type T is used by implemented methods to know what type of Symbol is encoded in the CodedSymbol.

A CodedSymbol can be peeled when the count is 1 or -1 and the hash matches

Fields

sum: Vec<u8>

hash: u64

count: i64

Implementations

impl<T: Symbol> CodedSymbol<T>

pub fn new() -> Self

pub fn apply(&mut self, s: &T, direction: Direction)

apply() adds or removes a symbol from the CodedSymbol

Adding a local, or removing a remote, symbol increases the count by 1

Removing a local, or adding a remote, symbol decreases the count by 1

pub fn combine(&self, b: &CodedSymbol<T>) -> CodedSymbol<T>

Used by the encoder to join two vectors of codedSymbols together produced from two distinct sets. The results are only valid if there were no duplicates between the original sets.

pub fn collapse(&self, b: &CodedSymbol<T>) -> CodedSymbol<T>

Used by the encoder to ‘subtract’ a remote set of codedSymbols from a local set.

pub fn is_peelable(&self) -> bool

Checks if the CodedSymbol contains only one symbol and therefore can be peeled

A count of 1 does not necessarily mean that the ‘sum’ field is the xor of only one encoded symbol. It could be the xor of two local and one remote symbols. This is why we also check the hash.

pub fn peel(&mut self) -> PeelableResult<T>

Peel extracts a symbol from the CodedSymbol (if possible) and returns it in a PeelableResult A PeelableResult is used to keep track of if the symbol was local or remote (or was not able to be peeled).

pub fn peel_peek(&self) -> PeelableResult<T>

same as peel, but does not modify the CodedSymbol

pub fn is_empty(&self) -> bool

Checks if the CodedSymbol contains no symbols

Trait Implementations

impl<T: Clone + Symbol> Clone for CodedSymbol<T>

fn clone(&self) -> CodedSymbol<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Symbol> Debug for CodedSymbol<T>

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

Formats the value using the given formatter.

impl<'de, T: Symbol> Deserialize<'de> for CodedSymbol<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Symbol> Serialize for CodedSymbol<T>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.