Struct Bloom 

pub struct Bloom {
    pub mandatory: u128,
    pub optional: u128,
}

Two 128-bit bloom filters (k=2 hashes) bundled into one wire type.

mandatory holds items the local node REQUIRES peers to also support.

optional holds items the local node would LIKE peers to support but doesn’t require.

Content-agnostic: items can be protocol ids, swarm keys, or any other identifier hashable as bytes. Discovery-layer hint, not

Fields

mandatory: u128

optional: u128

Implementations

impl Bloom

pub fn empty() -> Self

Empty filter.

pub fn add_mandatory<I: AsRef<[u8]>>(&mut self, item: I)

Insert a mandatory item.

pub fn add_optional<I: AsRef<[u8]>>(&mut self, item: I)

Insert an optional item.

pub fn all(&self) -> u128

Union of mandatory + optional bits (every item the peer claims).

pub fn may_contain<I: AsRef<[u8]>>(&self, item: I) -> bool

True if this filter might contain item in either set.

pub fn covers_mandatory(&self, mine: &Self) -> bool

True if this peer’s full set of items covers every bit in mine.mandatory.

pub fn intersects_optional(&self, mine: &Self) -> bool

True if this peer’s full set of items shares at least one bit with mine.optional. Trivially false if mine.optional is empty.

pub fn is_empty(&self) -> bool

True if neither mandatory nor optional has any bit set.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for Bloom

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for Bloom

fn clone(&self) -> Bloom

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bloom

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for Bloom

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Default for Bloom

fn default() -> Bloom

Returns the “default value” for a type.

impl Encode for Bloom

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl PartialEq for Bloom

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

impl Eq for Bloom

impl StructuralPartialEq for Bloom