Enum Accumulator

pub enum Accumulator {
    Term(Vec<u8>),
    Terms(Vec<Vec<u8>>),
}

The Accumulator type is used to represent one or many binary “terms” that can be collected from a compound index.

Variants

Term(Vec<u8>)

Terms(Vec<Vec<u8>>)

Implementations

impl Accumulator

pub fn from_salt<S>(salt: S) -> Accumulator

where S: AsRef<[u8]>,

pub fn truncate( self, term_length: usize, ) -> Result<Accumulator, AccumulatorError>

Truncate the terms in the accumulator to a specified length

The length must be less than or equal to MAX_TERM_LENGTH otherwise this method will return an error

pub fn terms(self) -> Vec<Vec<u8>>

Return a vector of the binary terms in the Accumulator

pub fn empty() -> Accumulator

pub fn exactly_one(self) -> Result<ExactlyOneAccumulator, AccumulatorError>

Return the accumulator term, only if there is exactly one term in the accumulator

pub fn combine(self, other: Accumulator) -> Accumulator

Combine this accumulator with another

Trait Implementations

impl Debug for Accumulator

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

Formats the value using the given formatter.

impl From<Accumulator> for IndexTerm

fn from(acc: Accumulator) -> IndexTerm

Converts to this type from the input type.