Struct alloy_primitives::Bloom
source · #[repr(transparent)]pub struct Bloom(pub FixedBytes<256>);
Expand description
Ethereum 256 byte bloom filter.
Tuple Fields§
§0: FixedBytes<256>
Implementations§
source§impl Bloom
impl Bloom
sourcepub const fn with_last_byte(x: u8) -> Self
pub const fn with_last_byte(x: u8) -> Self
Creates a new byte array with the last byte set to x
.
sourcepub const fn repeat_byte(byte: u8) -> Self
pub const fn repeat_byte(byte: u8) -> Self
Creates a new byte array where all bytes are set to byte
.
sourcepub fn from_slice(src: &[u8]) -> Self
pub fn from_slice(src: &[u8]) -> Self
sourcepub fn left_padding_from(value: &[u8]) -> Self
pub fn left_padding_from(value: &[u8]) -> Self
sourcepub fn right_padding_from(value: &[u8]) -> Self
pub fn right_padding_from(value: &[u8]) -> Self
sourcepub const fn into_array(self) -> [u8; 256]
pub const fn into_array(self) -> [u8; 256]
Returns the inner bytes array.
source§impl Bloom
impl Bloom
sourcepub fn data_mut(&mut self) -> &mut [u8; 256]
pub fn data_mut(&mut self) -> &mut [u8; 256]
Returns a mutable reference to the underlying data.
sourcepub fn contains_input(&self, input: BloomInput<'_>) -> bool
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.
sourcepub const fn const_contains(self, other: Self) -> bool
pub const fn const_contains(self, other: Self) -> bool
Compile-time version of contains
.
Note: This method may return false positives. This is inherent to the bloom filter data structure.
sourcepub fn contains(&self, other: &Self) -> bool
pub fn contains(&self, other: &Self) -> 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.
sourcepub fn accrue(&mut self, input: BloomInput<'_>)
pub fn accrue(&mut self, input: BloomInput<'_>)
Accrues the input into the bloom filter.
sourcepub fn accrue_bloom(&mut self, bloom: &Self)
pub fn accrue_bloom(&mut self, bloom: &Self)
Accrues the input into the bloom filter.
sourcepub fn m3_2048(&mut self, bytes: &[u8])
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).
sourcepub fn m3_2048_hashed(&mut self, hash: &B256)
pub fn m3_2048_hashed(&mut self, hash: &B256)
m3_2048
but with a pre-hashed input.
sourcepub fn accrue_raw_log(&mut self, address: Address, topics: &[B256])
pub fn accrue_raw_log(&mut self, address: Address, topics: &[B256])
Ingests a raw log into the bloom filter.
sourcepub fn accrue_log(&mut self, log: &Log)
pub fn accrue_log(&mut self, log: &Log)
Ingests a log into the bloom filter.
sourcepub fn contains_raw_log(&self, address: Address, topics: &[B256]) -> bool
pub fn contains_raw_log(&self, address: Address, topics: &[B256]) -> 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.
sourcepub fn contains_log(&self, log: &Log) -> bool
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: Self = _
sourcepub fn as_slice(&self) -> &[u8] ⓘ
pub fn as_slice(&self) -> &[u8] ⓘ
Returns a slice containing the entire array. Equivalent to &s[..]
.
sourcepub fn as_mut_slice(&mut self) -> &mut [u8] ⓘ
pub fn as_mut_slice(&mut self) -> &mut [u8] ⓘ
Returns a mutable slice containing the entire array. Equivalent to
&mut s[..]
.
sourcepub fn covers(&self, other: &Self) -> bool
pub fn covers(&self, other: &Self) -> bool
Returns true
if all bits set in self
are also set in b
.
sourcepub fn const_eq(&self, other: &Self) -> bool
pub fn const_eq(&self, other: &Self) -> bool
Compile-time equality. NOT constant-time equality.
sourcepub fn const_is_zero(&self) -> bool
pub fn const_is_zero(&self) -> bool
Returns true
if no bits are set.
Methods from Deref<Target = [u8; N]>§
1.57.0 · sourcepub fn as_slice(&self) -> &[T]
pub fn as_slice(&self) -> &[T]
Returns a slice containing the entire array. Equivalent to &s[..]
.
1.57.0 · sourcepub fn as_mut_slice(&mut self) -> &mut [T]
pub fn as_mut_slice(&mut self) -> &mut [T]
Returns a mutable slice containing the entire array. Equivalent to
&mut s[..]
.
1.77.0 · sourcepub fn each_ref(&self) -> [&T; N]
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 · sourcepub fn each_mut(&mut self) -> [&mut T; N]
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]);
sourcepub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])
🔬This is a nightly-only experimental API. (split_array
)
pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])
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, &[]);
}
sourcepub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])
🔬This is a nightly-only experimental API. (split_array
)
pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])
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]);
sourcepub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])
🔬This is a nightly-only experimental API. (split_array
)
pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])
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]);
}
sourcepub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])
🔬This is a nightly-only experimental API. (split_array
)
pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])
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]);
sourcepub fn as_ascii(&self) -> Option<&[AsciiChar; N]>
🔬This is a nightly-only experimental API. (ascii_char
)
pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>
ascii_char
)Converts this array of bytes into a array of ASCII characters,
or returns None
if any of the characters is non-ASCII.
§Examples
#![feature(ascii_char)]
#![feature(const_option)]
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");
sourcepub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]
🔬This is a nightly-only experimental API. (ascii_char
)
pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]
ascii_char
)Converts this array of bytes into a 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.
Trait Implementations§
source§impl AsMut<FixedBytes<256>> for Bloom
impl AsMut<FixedBytes<256>> for Bloom
source§fn as_mut(&mut self) -> &mut FixedBytes<256>
fn as_mut(&mut self) -> &mut FixedBytes<256>
source§impl AsRef<FixedBytes<256>> for Bloom
impl AsRef<FixedBytes<256>> for Bloom
source§fn as_ref(&self) -> &FixedBytes<256>
fn as_ref(&self) -> &FixedBytes<256>
source§impl BitAndAssign for Bloom
impl BitAndAssign for Bloom
source§fn bitand_assign(&mut self, rhs: Bloom)
fn bitand_assign(&mut self, rhs: Bloom)
&=
operation. Read moresource§impl BitOrAssign for Bloom
impl BitOrAssign for Bloom
source§fn bitor_assign(&mut self, rhs: Bloom)
fn bitor_assign(&mut self, rhs: Bloom)
|=
operation. Read moresource§impl BitXorAssign for Bloom
impl BitXorAssign for Bloom
source§fn bitxor_assign(&mut self, rhs: Bloom)
fn bitxor_assign(&mut self, rhs: Bloom)
^=
operation. Read moresource§impl<'de> Deserialize<'de> for Bloom
impl<'de> Deserialize<'de> for Bloom
source§fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
source§impl<'a> Extend<&'a (Address, LogData)> for Bloom
impl<'a> Extend<&'a (Address, LogData)> for Bloom
source§fn extend<T: IntoIterator<Item = &'a (Address, LogData)>>(&mut self, iter: T)
fn extend<T: IntoIterator<Item = &'a (Address, LogData)>>(&mut self, iter: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl<'a, 'b> Extend<&'a BloomInput<'b>> for Bloom
impl<'a, 'b> Extend<&'a BloomInput<'b>> for Bloom
source§fn extend<T: IntoIterator<Item = &'a BloomInput<'b>>>(&mut self, inputs: T)
fn extend<T: IntoIterator<Item = &'a BloomInput<'b>>>(&mut self, inputs: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl<'a> Extend<&'a Log> for Bloom
impl<'a> Extend<&'a Log> for Bloom
source§fn extend<T: IntoIterator<Item = &'a Log>>(&mut self, logs: T)
fn extend<T: IntoIterator<Item = &'a Log>>(&mut self, logs: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<Bloom> for FixedBytes<256>
impl From<Bloom> for FixedBytes<256>
source§impl From<BloomInput<'_>> for Bloom
impl From<BloomInput<'_>> for Bloom
source§fn from(input: BloomInput<'_>) -> Self
fn from(input: BloomInput<'_>) -> Self
source§impl From<FixedBytes<256>> for Bloom
impl From<FixedBytes<256>> for Bloom
source§fn from(value: FixedBytes<256>) -> Self
fn from(value: FixedBytes<256>) -> Self
source§impl<'a, 'b> FromIterator<&'a BloomInput<'b>> for Bloom
impl<'a, 'b> FromIterator<&'a BloomInput<'b>> for Bloom
source§fn from_iter<T: IntoIterator<Item = &'a BloomInput<'b>>>(inputs: T) -> Self
fn from_iter<T: IntoIterator<Item = &'a BloomInput<'b>>>(inputs: T) -> Self
source§impl<'a> FromIterator<&'a Log> for Bloom
impl<'a> FromIterator<&'a Log> for Bloom
source§impl<'__deriveMoreLifetime> IntoIterator for &'__deriveMoreLifetime Bloomwhere
&'__deriveMoreLifetime FixedBytes<256>: IntoIterator,
impl<'__deriveMoreLifetime> IntoIterator for &'__deriveMoreLifetime Bloomwhere
&'__deriveMoreLifetime FixedBytes<256>: IntoIterator,
§type Item = <&'__deriveMoreLifetime FixedBytes<256> as IntoIterator>::Item
type Item = <&'__deriveMoreLifetime FixedBytes<256> as IntoIterator>::Item
§type IntoIter = <&'__deriveMoreLifetime FixedBytes<256> as IntoIterator>::IntoIter
type IntoIter = <&'__deriveMoreLifetime FixedBytes<256> as IntoIterator>::IntoIter
source§impl<'__deriveMoreLifetime> IntoIterator for &'__deriveMoreLifetime mut Bloomwhere
&'__deriveMoreLifetime mut FixedBytes<256>: IntoIterator,
impl<'__deriveMoreLifetime> IntoIterator for &'__deriveMoreLifetime mut Bloomwhere
&'__deriveMoreLifetime mut FixedBytes<256>: IntoIterator,
§type Item = <&'__deriveMoreLifetime mut FixedBytes<256> as IntoIterator>::Item
type Item = <&'__deriveMoreLifetime mut FixedBytes<256> as IntoIterator>::Item
§type IntoIter = <&'__deriveMoreLifetime mut FixedBytes<256> as IntoIterator>::IntoIter
type IntoIter = <&'__deriveMoreLifetime mut FixedBytes<256> as IntoIterator>::IntoIter
source§impl IntoIterator for Bloomwhere
FixedBytes<256>: IntoIterator,
impl IntoIterator for Bloomwhere
FixedBytes<256>: IntoIterator,
§type Item = <FixedBytes<256> as IntoIterator>::Item
type Item = <FixedBytes<256> as IntoIterator>::Item
§type IntoIter = <FixedBytes<256> as IntoIterator>::IntoIter
type IntoIter = <FixedBytes<256> as IntoIterator>::IntoIter
source§impl Ord for Bloom
impl Ord for Bloom
source§impl PartialEq<&[u8]> for Bloom
impl PartialEq<&[u8]> for Bloom
source§impl PartialEq<&[u8; 256]> for Bloom
impl PartialEq<&[u8; 256]> for Bloom
source§impl PartialEq<&Bloom> for [u8]
impl PartialEq<&Bloom> for [u8]
source§impl PartialEq<&Bloom> for [u8; 256]
impl PartialEq<&Bloom> for [u8; 256]
source§impl PartialEq<[u8]> for &Bloom
impl PartialEq<[u8]> for &Bloom
source§impl PartialEq<[u8]> for Bloom
impl PartialEq<[u8]> for Bloom
source§impl PartialEq<[u8; 256]> for &Bloom
impl PartialEq<[u8; 256]> for &Bloom
source§impl PartialEq<[u8; 256]> for Bloom
impl PartialEq<[u8; 256]> for Bloom
source§impl PartialEq<Bloom> for &[u8]
impl PartialEq<Bloom> for &[u8]
source§impl PartialEq<Bloom> for &[u8; 256]
impl PartialEq<Bloom> for &[u8; 256]
source§impl PartialEq<Bloom> for [u8]
impl PartialEq<Bloom> for [u8]
source§impl PartialEq<Bloom> for [u8; 256]
impl PartialEq<Bloom> for [u8; 256]
source§impl PartialEq for Bloom
impl PartialEq for Bloom
source§impl PartialOrd<&[u8]> for Bloom
impl PartialOrd<&[u8]> for Bloom
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PartialOrd<&Bloom> for [u8]
impl PartialOrd<&Bloom> for [u8]
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PartialOrd<[u8]> for &Bloom
impl PartialOrd<[u8]> for &Bloom
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PartialOrd<[u8]> for Bloom
impl PartialOrd<[u8]> for Bloom
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PartialOrd<Bloom> for &[u8]
impl PartialOrd<Bloom> for &[u8]
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PartialOrd<Bloom> for [u8]
impl PartialOrd<Bloom> for [u8]
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PartialOrd for Bloom
impl PartialOrd for Bloom
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl Copy for Bloom
impl Eq for Bloom
impl MaxEncodedLen<{ $len }> for Bloom
impl StructuralPartialEq for Bloom
Auto Trait Implementations§
impl Freeze for Bloom
impl RefUnwindSafe for Bloom
impl Send for Bloom
impl Sync for Bloom
impl Unpin for Bloom
impl UnwindSafe for Bloom
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> ToHex for T
impl<T> ToHex for T
source§fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
ToHexExt
insteadself
into the result.
Lower case letters are used (e.g. f9b4ca
).source§fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
ToHexExt
insteadself
into the result.
Upper case letters are used (e.g. F9B4CA
).source§impl<T> ToHexExt for T
impl<T> ToHexExt for T
source§fn encode_hex(&self) -> String
fn encode_hex(&self) -> String
self
into the result.
Lower case letters are used (e.g. f9b4ca
).source§fn encode_hex_upper(&self) -> String
fn encode_hex_upper(&self) -> String
self
into the result.
Upper case letters are used (e.g. F9B4CA
).source§fn encode_hex_with_prefix(&self) -> String
fn encode_hex_with_prefix(&self) -> String
self
into the result with prefix 0x
.
Lower case letters are used (e.g. 0xf9b4ca
).source§fn encode_hex_upper_with_prefix(&self) -> String
fn encode_hex_upper_with_prefix(&self) -> String
self
into the result with prefix 0X
.
Upper case letters are used (e.g. 0xF9B4CA
).