Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidParameter {
        param: &'static str,
        reason: &'static str,
    },
    IncompatibleParameters,
    CapacityExceeded,
}

Errors returned by fallible operations across the crate.

Every constructor that accepts tuning parameters validates them and returns Error::InvalidParameter rather than panicking. Operations that combine two structures (for example BloomFilter::merge) return Error::IncompatibleParameters when the operands were not built with the same dimensions. A Cuckoo filter returns Error::CapacityExceeded when an insertion cannot find a free slot after exhausting its relocation budget.

The enum is #[non_exhaustive]: matching on it must include a wildcard arm so that future variants do not break downstream code.

Examples

use bloom_lib::Error;

let err = Error::InvalidParameter {
    param: "rate",
    reason: "must be in (0.0, 1.0)",
};
assert_eq!(err.to_string(), "invalid parameter `rate`: must be in (0.0, 1.0)");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidParameter

A tuning parameter fell outside its valid range.

param names the offending argument; reason states the constraint it violated. Both are static strings so the variant stays allocation-free and usable on no_std targets.

Fields

param: &'static str

The name of the parameter that was rejected.

reason: &'static str

A human-readable statement of the constraint that was violated.

IncompatibleParameters

Two structures could not be combined because their parameters differ.

Merging, intersecting, or comparing two probabilistic structures only has a defined meaning when both were constructed with identical dimensions (bit count, hash count, register precision, and so on).

CapacityExceeded

An insertion failed because the structure is full.

Returned by CuckooFilter::insert when no free slot is found within the relocation budget. It signals that the filter has reached its practical load limit; create a larger filter.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

Available on crate feature std only.

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for Error

fn eq(&self, other: &Error) -> 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 Eq for Error

impl StructuralPartialEq for Error