Struct sbloom::Bloom

#[repr(C)]
pub struct Bloom(pub [u8; 256]);

Unformatted binary data of fixed length.

Methods

impl Bloom

pub fn new() -> Bloom

Deprecated since 0.2.5:

use fixed_hash::zero constructor instead

Create a new, zero-initialised, instance.

pub fn zero() -> Bloom

Synonym for new(). Prefer to new as it's more readable.

pub fn len() -> usize

Deprecated since 0.2.5:

will be renamed to len_bytes to avoid confusion

Get the size of this object in bytes.

pub fn as_ptr(&self) -> *const u8

Returns a constant raw pointer to the value

pub fn as_mut_ptr(&mut self) -> *mut u8

pub fn clone_from_slice(&mut self, src: &[u8]) -> usize

Deprecated since 0.2.5:

unconventional API, replaced by assign_from_slice in version 0.3

Assign self to be of the same value as a slice of bytes of length len().

pub fn from_slice(src: &[u8]) -> Self

Deprecated since 0.2.5:

unconventional API, replaced by new_from_slice in version 0.3

Convert a slice of bytes of length len() to an instance of this type.

pub fn copy_to(&self, dest: &mut [u8])

Deprecated since 0.2.5:

use std::slice API instead

Copy the data of this object into some mutable slice of length len().

pub fn contains<'a>(&'a self, b: &'a Self) -> bool

Deprecated since 0.2.5:

will be renamed to covers in version 0.3

Returns true if all bits set in b are also set in self.

pub fn is_zero(&self) -> bool

Returns true if no bits are set.

pub fn low_u64(&self) -> u64

Deprecated since 0.2.5:

will be renamed to low_u64_be in version 0.3

Returns the lowest 8 bytes interpreted as a BigEndian integer.

pub fn random() -> Bloom

Create a new, cryptographically random, instance.

pub fn randomize(&mut self)

Assign self have a cryptographically random value.

impl Bloom

pub fn hex(&self) -> String

Deprecated:

Use LowerHex or Debug formatting instead.

Get a hex representation.

impl Bloom

pub fn is_empty(&self) -> bool

pub fn contains_input<'a>(&self, input: Input<'a>) -> bool

pub fn contains_bloom<'a, B>(&self, bloom: B) -> bool where
    BloomRef<'a>: From<B>, 

pub fn accrue<'a>(&mut self, input: Input<'a>)

pub fn accrue_bloom<'a, B>(&mut self, bloom: B) where
    BloomRef<'a>: From<B>, 

pub fn data(&self) -> &[u8; 256]

Trait Implementations

impl AsRef<[u8]> for Bloom

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<Bloom> for Bloom

fn as_ref(&self) -> &Bloom

Performs the conversion.

impl Default for Bloom

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Bloom

fn clone(&self) -> Bloom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Bloom

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl From<[u8; 256]> for Bloom

fn from(bytes: [u8; 256]) -> Self

Performs the conversion.

impl From<Bloom> for [u8; 256]

fn from(s: Bloom) -> Self

Performs the conversion.

impl From<u64> for Bloom

fn from(value: u64) -> Bloom

Performs the conversion.

impl<'a> From<&'a [u8]> for Bloom

fn from(s: &'a [u8]) -> Bloom

Performs the conversion.

impl From<&'static str> for Bloom

fn from(s: &'static str) -> Bloom

Performs the conversion.

impl<'a> From<Input<'a>> for Bloom

fn from(input: Input<'a>) -> Bloom

Performs the conversion.

impl<'a> From<&'a Bloom> for BloomRef<'a>

fn from(bloom: &'a Bloom) -> Self

Performs the conversion.

impl Eq for Bloom

impl Copy for Bloom

impl PartialOrd<Bloom> for Bloom

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl AsMut<[u8]> for Bloom

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl PartialEq<Bloom> for Bloom

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<BloomRef<'a>> for Bloom

fn eq(&self, other: &BloomRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Deref for Bloom

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &[u8]

Dereferences the value.

impl Debug for Bloom

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

Formats the value using the given formatter.

impl Display for Bloom

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

Formats the value using the given formatter.

impl FromStr for Bloom

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Bloom, FromHexError>

Parses a string s to return a value of this type.

impl<'a> BitAnd<&'a Bloom> for &'a Bloom

BitAnd on references

type Output = Bloom

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAnd<Bloom> for Bloom

Moving BitAnd

type Output = Bloom

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl<'a> BitOr<&'a Bloom> for &'a Bloom

BitOr on references

type Output = Bloom

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr<Bloom> for Bloom

Moving BitOr

type Output = Bloom

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<'a> BitXor<&'a Bloom> for &'a Bloom

BitXor on references

type Output = Bloom

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXor<Bloom> for Bloom

Moving BitXor

type Output = Bloom

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl DerefMut for Bloom

fn deref_mut(&mut self) -> &mut [u8]

Mutably dereferences the value.

impl Index<usize> for Bloom

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &u8

Performs the indexing (container[index]) operation.

impl Index<Range<usize>> for Bloom

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for Bloom

type Output = [u8]

The returned type after indexing.

fn index(&self, _index: RangeFull) -> &[u8]

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Bloom

fn index_mut(&mut self, index: usize) -> &mut u8

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Range<usize>> for Bloom

fn index_mut(&mut self, index: Range<usize>) -> &mut [u8]

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeFull> for Bloom

fn index_mut(&mut self, _index: RangeFull) -> &mut [u8]

Performs the mutable indexing (container[index]) operation.

impl Hash for Bloom

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for Bloom

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

Formats the value using the given formatter.

impl HeapSizeOf for Bloom

fn heap_size_of_children(&self) -> usize

Measure the size of any heap-allocated structures that hang off this value, but not the space taken up by the value itself (i.e. what size_of:: measures, more or less); that space is handled by the implementation of HeapSizeOf for Box below.

impl Rand for Bloom

fn rand<R: Rng>(r: &mut R) -> Self

Generates a random instance of this type using the specified source of randomness.

impl Serialize for Bloom

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Bloom

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.