Struct Bloom Copy item path

impl Bloom

pub const ZERO: Bloom = _

Array of Zero bytes.

pub const fn new(bytes: [u8; 256]) -> Bloom

Wraps the given byte array in this type.

pub const fn with_last_byte(x: u8) -> Bloom

Creates a new byte array with the last byte set to x.

pub const fn repeat_byte(byte: u8) -> Bloom

Creates a new byte array where all bytes are set to byte.

pub const fn len_bytes() -> usize

Returns the size of this array in bytes.

pub fn random() -> Bloom

Instantiates a new fixed byte array with cryptographically random content.

§Panics

Panics if the underlying call to getrandom_uninit fails.

pub fn try_random() -> Result<Bloom, Error>

Tries to create a new fixed byte array with cryptographically random content.

§Errors

This function only propagates the error from the underlying call to getrandom_uninit.

pub fn randomize(&mut self)

Fills this fixed byte array with cryptographically random content.

§Panics

Panics if the underlying call to getrandom_uninit fails.

pub fn try_randomize(&mut self) -> Result<(), Error>

Tries to fill this fixed byte array with cryptographically random content.

§Errors

This function only propagates the error from the underlying call to getrandom_uninit.

pub fn random_with<R>(rng: &mut R) -> Bloom
where R: Rng + ?Sized,

Creates a new fixed byte array with the given random number generator.

pub fn randomize_with<R>(&mut self, rng: &mut R)
where R: Rng + ?Sized,

Fills this fixed byte array with the given random number generator.

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

Create a new byte array from the given slice src.

For a fallible version, use the TryFrom<&[u8]> implementation.

§Note

The given bytes are interpreted in big endian order.

§Panics

If the length of src and the number of bytes in Self do not match.

pub fn left_padding_from(value: &[u8]) -> Bloom

Create a new byte array from the given slice src, left-padding it with zeroes if necessary.

§Note

The given bytes are interpreted in big endian order.

§Panics

Panics if src.len() > N.

pub fn right_padding_from(value: &[u8]) -> Bloom

Create a new byte array from the given slice src, right-padding it with zeroes if necessary.

§Note

The given bytes are interpreted in big endian order.

§Panics

Panics if src.len() > N.

pub const fn into_array(self) -> [u8; 256]

Returns the inner bytes array.

pub fn covers(&self, b: &Bloom) -> bool

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

pub const fn const_eq(&self, other: &Bloom) -> bool

Compile-time equality. NOT constant-time equality.

pub const fn bit_and(self, rhs: Bloom) -> Bloom

Computes the bitwise AND of two FixedBytes.

pub const fn bit_or(self, rhs: Bloom) -> Bloom

Computes the bitwise OR of two FixedBytes.

pub const fn bit_xor(self, rhs: Bloom) -> Bloom

Computes the bitwise XOR of two FixedBytes.

impl Bloom

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

Returns a reference to the underlying data.

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

Returns a mutable reference to the underlying data.

pub fn contains_input(&self, input: BloomInput<'_>) -> bool

Returns true if this bloom filter is a possible superset of the other bloom filter, admitting false positives.

Note: This method may return false positives. This is inherent to the bloom filter data structure.

pub const fn const_contains(self, other: Bloom) -> bool

Compile-time version of contains.

Note: This method may return false positives. This is inherent to the bloom filter data structure.

pub fn contains(&self, other: &Bloom) -> bool

Returns true if this bloom filter is a possible superset of the other bloom filter, admitting false positives.

Note: This method may return false positives. This is inherent to the bloom filter data structure.

pub fn accrue(&mut self, input: BloomInput<'_>)

Accrues the input into the bloom filter.

pub fn accrue_bloom(&mut self, bloom: &Bloom)

Accrues the input into the bloom filter.

pub fn m3_2048(&mut self, bytes: &[u8])

Specialised Bloom filter that sets three bits out of 2048, given an arbitrary byte sequence.

See Section 4.3.1 “Transaction Receipt” of the Ethereum Yellow Paper (page 6).

pub fn m3_2048_hashed(&mut self, hash: &FixedBytes<32>)

m3_2048 but with a pre-hashed input.

pub fn accrue_raw_log(&mut self, address: Address, topics: &[FixedBytes<32>])

Ingests a raw log into the bloom filter.

pub fn accrue_log(&mut self, log: &Log)

Ingests a log into the bloom filter.

pub fn contains_raw_log( &self, address: Address, topics: &[FixedBytes<32>], ) -> bool

True if the bloom filter contains a log with given address and topics.

Note: This method may return false positives. This is inherent to the bloom filter data structure.

pub fn contains_log(&self, log: &Log) -> bool

True if the bloom filter contains a log with given address and topics.

Note: This method may return false positives. This is inherent to the bloom filter data structure.

Methods from Deref<Target = FixedBytes<256>>§

pub const ZERO: FixedBytes<N> = _

pub fn randomize(&mut self)

Available on crate feature getrandom only.

Fills this FixedBytes with cryptographically random content.

§Panics

Panics if the underlying call to getrandom_uninit fails.

pub fn try_randomize(&mut self) -> Result<(), Error>

Available on crate feature getrandom only.

Tries to fill this FixedBytes with cryptographically random content.

§Errors

This function only propagates the error from the underlying call to getrandom_uninit.

pub fn randomize_with<R>(&mut self, rng: &mut R)
where R: Rng + ?Sized,

Available on crate feature rand only.

Fills this FixedBytes with the given random number generator.

pub fn as_slice(&self) -> &[u8] ⓘ

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [u8] ⓘ

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn covers(&self, other: &FixedBytes<N>) -> bool

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

pub fn const_eq(&self, other: &FixedBytes<N>) -> bool

Compile-time equality. NOT constant-time equality.

pub fn is_zero(&self) -> bool

Returns true if no bits are set.

pub fn const_is_zero(&self) -> bool

Returns true if no bits are set.

Methods from Deref<Target = [u8; N]>§

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

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

Converts this array of bytes into an array of ASCII characters, or returns None if any of the characters is non-ASCII.

§Examples

#![feature(ascii_char)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

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

Converts this array of bytes into an array of ASCII characters, without checking whether they’re valid.

§Safety

Every byte in the array must be in 0..=127, or else this is UB.

1.57.0 · Source

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

1.57.0 · Source

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

1.77.0 · Source

pub fn each_ref(&self) -> [&T; N]

Borrows each element and returns an array of references with the same size as self.

§Example

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

1.77.0 · Source

pub fn each_mut(&mut self) -> [&mut T; N]

Borrows each element mutably and returns an array of mutable references with the same size as self.

§Example


let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

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

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

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

Divides one mutable array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

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

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

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

Divides one mutable array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

Trait Implementations§

impl<'a> Arbitrary<'a> for Bloom

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Bloom, Error>

Generate an arbitrary value of Self from the given unstructured data. Read more

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Bloom, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more

impl Arbitrary for Bloom

type Parameters = <FixedBytes<256> as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<FixedBytes<256> as Arbitrary>::Strategy, fn(_: FixedBytes<256>) -> Bloom>

The type of Strategy used to generate values of type Self.

fn arbitrary() -> <Bloom as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more

fn arbitrary_with( args: <Bloom as Arbitrary>::Parameters, ) -> <Bloom as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more

impl AsMut<[u8]> for Bloom

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<[u8; 256]> for Bloom

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<FixedBytes<256>> for Bloom

fn as_mut(&mut self) -> &mut FixedBytes<256>

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Bloom

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

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 256]> for Bloom

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

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<FixedBytes<256>> for Bloom

fn as_ref(&self) -> &FixedBytes<256>

Converts this type into a shared reference of the (usually inferred) input type.

impl BitAnd for Bloom

type Output = Bloom

The resulting type after applying the & operator.

fn bitand(self, rhs: Bloom) -> Bloom

Performs the & operation. Read more

impl BitAndAssign for Bloom

fn bitand_assign(&mut self, rhs: Bloom)

Performs the &= operation. Read more

impl BitOr for Bloom

type Output = Bloom

The resulting type after applying the | operator.

fn bitor(self, rhs: Bloom) -> Bloom

Performs the | operation. Read more

impl BitOrAssign for Bloom

fn bitor_assign(&mut self, rhs: Bloom)

Performs the |= operation. Read more

impl BitXor for Bloom

type Output = Bloom

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Bloom) -> Bloom

Performs the ^ operation. Read more

impl BitXorAssign for Bloom

fn bitxor_assign(&mut self, rhs: Bloom)

Performs the ^= operation. Read more

impl Borrow<[u8]> for &Bloom

fn borrow(&self) -> &[u8] ⓘ

Immutably borrows from an owned value. Read more

impl Borrow<[u8]> for &mut Bloom

fn borrow(&self) -> &[u8] ⓘ

Immutably borrows from an owned value. Read more

impl Borrow<[u8]> for Bloom

fn borrow(&self) -> &[u8] ⓘ

Immutably borrows from an owned value. Read more

impl Borrow<[u8; 256]> for &Bloom

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

Immutably borrows from an owned value. Read more

impl Borrow<[u8; 256]> for &mut Bloom

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

Immutably borrows from an owned value. Read more

impl Borrow<[u8; 256]> for Bloom

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

Immutably borrows from an owned value. Read more

impl BorrowMut<[u8]> for &mut Bloom

fn borrow_mut(&mut self) -> &mut [u8] ⓘ

Mutably borrows from an owned value. Read more

impl BorrowMut<[u8]> for Bloom

fn borrow_mut(&mut self) -> &mut [u8] ⓘ

Mutably borrows from an owned value. Read more

impl BorrowMut<[u8; 256]> for &mut Bloom

fn borrow_mut(&mut self) -> &mut [u8; 256]

Mutably borrows from an owned value. Read more

impl BorrowMut<[u8; 256]> for Bloom

fn borrow_mut(&mut self) -> &mut [u8; 256]

Mutably borrows from an owned value. Read more

impl Clone for Bloom

fn clone(&self) -> Bloom

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Bloom

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

Formats the value using the given formatter. Read more

impl Decodable for Bloom

fn decode(buf: &mut &[u8]) -> Result<Bloom, Error>

Decodes the blob into the appropriate type. buf must be advanced past the decoded object.

impl Default for Bloom

fn default() -> Bloom

Returns the “default value” for a type. Read more

impl Deref for Bloom

type Target = FixedBytes<256>

The resulting type after dereferencing.

fn deref(&self) -> &<Bloom as Deref>::Target

Dereferences the value.

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

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for Bloom

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

Formats the value using the given formatter. Read more

impl Distribution<Bloom> for Standard

fn sample<R>(&self, rng: &mut R) -> Bloom
where R: Rng + ?Sized,

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> ⓘ
where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness. Read more

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>
where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more

impl Encodable for Bloom

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes. Read more

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.

impl<'a> Extend<&'a (Address, LogData)> for Bloom

fn extend<T>(&mut self, iter: T)
where T: IntoIterator<Item = &'a (Address, LogData)>,

Extends a collection with the contents of an iterator. Read more

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements. Read more

impl<'a, 'b> Extend<&'a BloomInput<'b>> for Bloom

fn extend<T>(&mut self, inputs: T)
where T: IntoIterator<Item = &'a BloomInput<'b>>,

Extends a collection with the contents of an iterator. Read more

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements. Read more

impl<'a> Extend<&'a Log> for Bloom

fn extend<T>(&mut self, logs: T)
where T: IntoIterator<Item = &'a Log>,

Extends a collection with the contents of an iterator. Read more

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements. Read more