Struct ethereum_types::Bloom

[+] Show declaration

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

[−] Expand description

Bloom hash type with 256 bytes (2048 bits) size.

Implementations

impl Bloom[−]

pub fn is_empty(&self) -> bool

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

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

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

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

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

impl Bloom[−]

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

Returns a new fixed hash where all bits are set to the given byte.

pub const fn zero() -> Bloom[−]

Returns a new zero-initialized fixed hash.

pub const fn len_bytes() -> usize[−]

Returns the size of this hash in bytes.

pub fn as_bytes(&self) -> &[u8][−]

Extracts a byte slice containing the entire fixed hash.

pub fn as_bytes_mut(&mut self) -> &mut [u8][−]

Extracts a mutable byte slice containing the entire fixed hash.

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

Extracts a reference to the byte array containing the entire fixed hash.

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

Extracts a reference to the byte array containing the entire fixed hash.

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

Returns the inner bytes array.

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

Returns a constant raw pointer to the value.

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

Returns a mutable raw pointer to the value.

pub fn assign_from_slice(&mut self, src: &[u8])[−]

Assign the bytes from the byte slice src to self.

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 from_slice(src: &[u8]) -> Bloom[−]

Create a new fixed-hash from the given slice src.

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 covers(&self, b: &Bloom) -> bool[−]

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.

impl Bloom[−]

[−] Expand description

Utilities using the byteorder crate.

pub fn to_low_u64_be(&self) -> u64[−]

Returns the lowest 8 bytes interpreted as big-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

pub fn to_low_u64_le(&self) -> u64[−]

Returns the lowest 8 bytes interpreted as little-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

pub fn to_low_u64_ne(&self) -> u64[−]

Returns the lowest 8 bytes interpreted as native-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

pub fn from_low_u64_be(val: u64) -> Bloom[−]

Creates a new hash type from the given u64 value.

Note

• The given u64 value is interpreted as big endian.
• Ignores the most significant bits of the given value if the hash type has less than 8 bytes.

pub fn from_low_u64_le(val: u64) -> Bloom[−]

Creates a new hash type from the given u64 value.

Note

• The given u64 value is interpreted as little endian.
• Ignores the most significant bits of the given value if the hash type has less than 8 bytes.

pub fn from_low_u64_ne(val: u64) -> Bloom[−]

Creates a new hash type from the given u64 value.

Note

• The given u64 value is interpreted as native endian.
• Ignores the most significant bits of the given value if the hash type has less than 8 bytes.

impl Bloom[−]

[−] Expand description

Utilities using the rand crate.

pub fn randomize_using<R>(&mut self, rng: &mut R) where
    R: Rng + ?Sized, [−]

Assign self to a cryptographically random value using the given random number generator.

pub fn randomize(&mut self)[−]

Assign self to a cryptographically random value.

pub fn random_using<R>(rng: &mut R) -> Bloom where
    R: Rng + ?Sized, [−]

Create a new hash with cryptographically random content using the given random number generator.

pub fn random() -> Bloom[−]

Create a new hash with cryptographically random content.

Trait Implementations

impl AsMut<[u8]> for Bloom[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl AsRef<[u8]> for Bloom[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl<'l, 'r> BitAnd<&'r Bloom> for &'l Bloom[+]

[+] Show hidden undocumented items

type Output = Bloom

The resulting type after applying the & operator.

fn bitand(self, rhs: &'r Bloom) -> <&'l Bloom as BitAnd<&'r Bloom>>::Output[−]

Performs the & operation.

impl BitAnd<Bloom> for Bloom[+]

[+] Show hidden undocumented items

type Output = Bloom

The resulting type after applying the & operator.

fn bitand(self, rhs: Bloom) -> <Bloom as BitAnd<Bloom>>::Output[−]

Performs the & operation.

impl<'r> BitAndAssign<&'r Bloom> for Bloom[+]

[+] Show hidden undocumented items

fn bitand_assign(&mut self, rhs: &'r Bloom)[−]

Performs the &= operation.

impl BitAndAssign<Bloom> for Bloom[+]

[+] Show hidden undocumented items

fn bitand_assign(&mut self, rhs: Bloom)[−]

Performs the &= operation.

impl<'l, 'r> BitOr<&'r Bloom> for &'l Bloom[+]

[+] Show hidden undocumented items

type Output = Bloom

The resulting type after applying the | operator.

fn bitor(self, rhs: &'r Bloom) -> <&'l Bloom as BitOr<&'r Bloom>>::Output[−]

Performs the | operation.

impl BitOr<Bloom> for Bloom[+]

[+] Show hidden undocumented items

type Output = Bloom

The resulting type after applying the | operator.

fn bitor(self, rhs: Bloom) -> <Bloom as BitOr<Bloom>>::Output[−]

Performs the | operation.

impl<'r> BitOrAssign<&'r Bloom> for Bloom[+]

[+] Show hidden undocumented items

fn bitor_assign(&mut self, rhs: &'r Bloom)[−]

Performs the |= operation.

impl BitOrAssign<Bloom> for Bloom[+]

[+] Show hidden undocumented items

fn bitor_assign(&mut self, rhs: Bloom)[−]

Performs the |= operation.

impl<'l, 'r> BitXor<&'r Bloom> for &'l Bloom[+]

[+] Show hidden undocumented items

type Output = Bloom

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'r Bloom) -> <&'l Bloom as BitXor<&'r Bloom>>::Output[−]

Performs the ^ operation.

impl BitXor<Bloom> for Bloom[+]

[+] Show hidden undocumented items

type Output = Bloom

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Bloom) -> <Bloom as BitXor<Bloom>>::Output[−]

Performs the ^ operation.

impl<'r> BitXorAssign<&'r Bloom> for Bloom[+]

[+] Show hidden undocumented items

fn bitxor_assign(&mut self, rhs: &'r Bloom)[−]

Performs the ^= operation.

impl BitXorAssign<Bloom> for Bloom[+]

[+] Show hidden undocumented items

fn bitxor_assign(&mut self, rhs: Bloom)[−]

Performs the ^= operation.

impl Clone for Bloom[+]

[+] Show hidden undocumented items

fn clone(&self) -> Bloom[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for Bloom

impl Debug for Bloom[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Decodable for Bloom[+]

[+] Show hidden undocumented items

fn decode(rlp: &Rlp<'_>) -> Result<Bloom, DecoderError>[−]

Decode a value from RLP bytes

impl Default for Bloom[+]

[+] Show hidden undocumented items

fn default() -> Bloom[−]

Returns the "default value" for a type.

impl Display for Bloom[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Encodable for Bloom[+]

[+] Show hidden undocumented items

fn rlp_append(&self, s: &mut RlpStream)[−]

Append a value to the stream

fn rlp_bytes(&self) -> Vec<u8>[−]

Get rlp-encoded bytes for this instance

impl Eq for Bloom

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

fn from(bytes: &'a [u8; 256]) -> Bloom[−]

Constructs a hash type from the given reference to the bytes array of fixed length.

Note

The given bytes are interpreted in big endian order.

impl<'a> From<&'a Bloom> for BloomRef<'a>[+]

[+] Show hidden undocumented items

fn from(bloom: &'a Bloom) -> BloomRef<'a>[−]

Performs the conversion.

impl<'a> From<&'a mut [u8; 256]> for Bloom[+]

fn from(bytes: &'a mut [u8; 256]) -> Bloom[−]

Constructs a hash type from the given reference to the mutable bytes array of fixed length.

Note

The given bytes are interpreted in big endian order.

impl From<[u8; 256]> for Bloom[+]

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

Constructs a hash type from the given bytes array of fixed length.

Note

The given bytes are interpreted in big endian order.

impl<'a> From<Input<'a>> for Bloom[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl FromStr for Bloom[+]

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Bloom, FromHexError>[−]

Creates a hash type instance from the given string.

Note

The given input string is interpreted in big endian.

Errors

• When encountering invalid non hex-digits
• Upon empty string input or invalid input length in general

impl Hash for Bloom[+]

[+] Show hidden undocumented items

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<I> Index<I> for Bloom where
    I: SliceIndex<[u8]>, [+]

[+] Show hidden undocumented items

type Output = <I as SliceIndex<[u8]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &<I as SliceIndex<[u8]>>::Output[−]

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for Bloom where
    I: SliceIndex<[u8], Output = [u8]>, [+]

[+] Show hidden undocumented items

fn index_mut(&mut self, index: I) -> &mut <I as SliceIndex<[u8]>>::Output[−]

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

impl LowerHex for Bloom[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Ord for Bloom[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &Bloom) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

#[must_use]fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[−]

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

Restrict a value to a certain interval.

impl PartialEq<Bloom> for Bloom[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Bloom) -> bool[−]

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

[+] Expand attributes

#[must_use]fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl<'a> PartialEq<BloomRef<'a>> for Bloom[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

#[must_use]fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialOrd<Bloom> for Bloom[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &Bloom) -> Option<Ordering>[−]

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

[+] Expand attributes

#[must_use]fn lt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[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.

[+] Expand attributes

#[must_use]fn gt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[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 UpperHex for Bloom[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.