Struct BfInsertOptions

pub struct BfInsertOptions { /* private fields */ }

Available on crate feature redis-bloom only.

Options for the bf_insert command.

Implementations

impl BfInsertOptions

pub fn capacity(self, capacity: usize) -> Self

Specifies the desired capacity for the filter to be created.

This parameter is ignored if the filter already exists. If the filter is automatically created and this parameter is absent, then the module-level capacity is used. See bf_reserve for more information about the impact of this value.

pub fn error(self, error_rate: f64) -> Self

Specifies the error ratio of the newly created filter if it does not yet exist.

If the filter is automatically created and error is not specified then the module-level error rate is used. See bf_reserve for more information about the format of this value.

pub fn expansion(self, expansion: usize) -> Self

When capacity is reached, an additional sub-filter is created. The size of the new sub-filter is the size of the last sub-filter multiplied by expansion. If the number of elements to be stored in the filter is unknown, we recommend that you use an expansion of 2 or more to reduce the number of sub-filters. Otherwise, we recommend that you use an expansion of 1 to reduce memory consumption. The default expansion value is 2.

pub fn nocreate(self) -> Self

Indicates that the filter should not be created if it does not already exist.

If the filter does not yet exist, an error is returned rather than creating it automatically. This may be used where a strict separation between filter creation and filter addition is desired. It is an error to specify nocreate together with either capacity or error.

pub fn nonscaling(self) -> Self

Prevents the filter from creating additional sub-filters if initial capacity is reached.

Non-scaling filters require slightly less memory than their scaling counterparts. The filter returns an error when capacity is reached.

Trait Implementations

impl Default for BfInsertOptions

fn default() -> BfInsertOptions

Returns the “default value” for a type.

impl ToArgs for BfInsertOptions

fn write_args(&self, args: &mut CommandArgs)

Write this Rust type as one ore multiple args into CommandArgs.

fn num_args(&self) -> usize

Number arguments generated by this Rust type