Struct CompressedAccountFilterSet 

pub struct CompressedAccountFilterSet { /* private fields */ }

Safe builder for cuckoo filters sent in subscribe requests.

Holds two parallel collections: a HashSet (exact source of truth for contains/len and the guard for writes) and a CuckooFilter (compact wire form). Writes go to both; serialization reads the filter. Strictly safer than a raw CuckooFilter, whose remove can silently evict the wrong fingerprint-colliding item.

Implementations

impl CompressedAccountFilterSet

pub fn with_capacity( max_capacity: usize, ) -> Result<CompressedAccountFilterSet, CuckooBuildError>

Empty map pre-sized for max_capacity items (both the HashSet and filter are allocated up front). Errors CuckooBuildError::CapacityOverflow if it can’t be allocated.

pub fn insert(&mut self, key: Address) -> Result<bool, TableFullError>

Inserts a key. Ok(true) if newly added, Ok(false) if already present (idempotent). Errors TableFullError if the filter is saturated (map under-sized); state is unchanged on error.

pub fn remove(&mut self, key: Address) -> bool

Removes a key; returns whether it was present. Safe unlike CuckooFilter::remove: checks the HashSet first and only touches the filter when the key genuinely exists.

pub fn contains(&self, key: Address) -> bool

Exact membership (from the HashSet, no false positives), unlike CuckooFilter::contains.

pub fn len(&self) -> usize

Returns the number of items in the map.

pub fn capacity(&self) -> usize

Items the map can hold without reallocating (≥ the with_capacity argument; the HashSet rounds up). Useful for headroom checks before a batch of inserts.

pub fn iter(&self) -> impl Iterator<Item = &[u8; 32]>

Iterates items in arbitrary HashSet order (no ordering guarantee).

pub fn is_empty(&self) -> bool

Returns true if the map contains no items.

pub const fn is_dirty(&self) -> bool

true if mutated since the last take_dirty (or construction); does not clear the flag.

pub fn take_dirty(&mut self) -> bool

Returns the dirty flag and clears it. Call when transmitting: true → rebuild and send.

pub fn to_proto(&self) -> CuckooFilter

Serializes the cuckoo filter to proto wire format (carries bucket geometry + hash seed).

pub fn to_account_filter(&self) -> SubscribeRequestFilterAccounts

A SubscribeRequestFilterAccounts carrying only this cuckoo filter (no account list, owner, or predicates) — add it to a request under a name of your choosing.

pub fn insert_into_subscribe_request( &mut self, req: &mut SubscribeRequest, name: &str, )

Inserts this filter into req.accounts under name (replacing any existing entry, preserving others) and marks the map clean.