Struct golomb_set::Gcs

pub struct Gcs<D: Digest> { /* fields omitted */ }

A packed Golomb-coded Set.

Methods

impl<D: Digest> Gcs<D>

pub fn from_reader<R: Read>(
    reader: &mut R,
    n: usize,
    p: u8
) -> Result<Self, Error>

Read a packed Gcs from any Reader.

Errors

• If there is an error reading data from reader.

pub fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes a packed Gcs to a Writer.

Errors

• If there is an error writing data to writer.

pub fn contains<A: AsRef<[u8]>>(&self, input: A) -> bool

Returns whether or not an input is contained in the set. If false the input is definitely not present, if true the input is probably present.

Errors

• If the inner data is not a valid Golomb-Rice encoding.

pub fn unpack(&self) -> UnpackedGcs<D>

Unpacks a Gcs into an UnpackedGcs.

This will will increase query performance, but also increase the memory footprint.

Errors

• If the inner data is not a valid Golomb-Rice encoding.

Trait Implementations

impl<D: PartialEq + Digest> PartialEq<Gcs<D>> for Gcs<D>

fn eq(&self, other: &Gcs<D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Gcs<D>) -> bool

This method tests for !=.

impl<D: Clone + Digest> Clone for Gcs<D>

fn clone(&self) -> Gcs<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug + Digest> Debug for Gcs<D>

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

Formats the value using the given formatter.