Struct RiceDeltaEncoding 

#[non_exhaustive]
pub struct RiceDeltaEncoding {
    pub first_value: i64,
    pub rice_parameter: i32,
    pub entry_count: i32,
    pub encoded_data: Bytes,
    /* private fields */
}

The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

first_value: i64

The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer’s value. If the field is empty or missing, assume zero.

rice_parameter: i32

The Golomb-Rice parameter, which is a number between 2 and 28. This field is missing (that is, zero) if num_entries is zero.

entry_count: i32

The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in first_value.

encoded_data: Bytes

The encoded deltas that are encoded using the Golomb-Rice coder.

Implementations

impl RiceDeltaEncoding

pub fn new() -> Self

pub fn set_first_value<T: Into<i64>>(self, v: T) -> Self

Sets the value of first_value.

Example

let x = RiceDeltaEncoding::new().set_first_value(42);

pub fn set_rice_parameter<T: Into<i32>>(self, v: T) -> Self

Sets the value of rice_parameter.

Example

let x = RiceDeltaEncoding::new().set_rice_parameter(42);

pub fn set_entry_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of entry_count.

Example

let x = RiceDeltaEncoding::new().set_entry_count(42);

pub fn set_encoded_data<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of encoded_data.

Example

let x = RiceDeltaEncoding::new().set_encoded_data(bytes::Bytes::from_static(b"example"));

Trait Implementations

impl Clone for RiceDeltaEncoding

fn clone(&self) -> RiceDeltaEncoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RiceDeltaEncoding

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

Formats the value using the given formatter.

impl Default for RiceDeltaEncoding

fn default() -> RiceDeltaEncoding

Returns the “default value” for a type.

impl Message for RiceDeltaEncoding

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RiceDeltaEncoding

fn eq(&self, other: &RiceDeltaEncoding) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RiceDeltaEncoding