Enum FilterBlockOption

pub enum FilterBlockOption {
    Range {
        from_block: Option<BlockNumberOrTag>,
        to_block: Option<BlockNumberOrTag>,
    },
    AtBlockHash(FixedBytes<32>),
}

Available on crate feature rpc only.

Represents the target range of blocks for the filter

Variants

Range

Represents a range of blocks with optional from and to blocks

Note: ranges are considered to be inclusive

Fields

from_block: Option<BlockNumberOrTag>

The block number or tag this filter should start at.

to_block: Option<BlockNumberOrTag>

The block number or that this filter should end at.

AtBlockHash(FixedBytes<32>)

The hash of the block if the filter only targets a single block

Implementations

impl FilterBlockOption

pub const fn get_to_block(&self) -> Option<&BlockNumberOrTag>

Returns the from_block value, if any

pub const fn get_from_block(&self) -> Option<&BlockNumberOrTag>

Returns the to_block value, if any

pub const fn as_range( &self, ) -> (Option<&BlockNumberOrTag>, Option<&BlockNumberOrTag>)

Returns the range (from_block, to_block) if this is a range filter.

pub const fn as_block_hash(&self) -> Option<&FixedBytes<32>>

Returns the block hash if this is a block hash filter.

pub const fn is_range(&self) -> bool

Returns true if this is a range filter.

pub const fn is_block_hash(&self) -> bool

Returns true if this is a block hash filter.

pub fn ensure_valid_block_range(&self) -> Result<(), FilterBlockError>

Ensure block range validity

pub fn with_from_block(&self, block: BlockNumberOrTag) -> FilterBlockOption

Sets the block number this range filter should start at.

pub fn with_to_block(&self, block: BlockNumberOrTag) -> FilterBlockOption

Sets the block number this range filter should end at.

pub const fn with_block_hash(&self, hash: FixedBytes<32>) -> FilterBlockOption

Pins the block hash this filter should target.

Trait Implementations

impl Clone for FilterBlockOption

fn clone(&self) -> FilterBlockOption

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilterBlockOption

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

Formats the value using the given formatter.

impl Default for FilterBlockOption

fn default() -> FilterBlockOption

Returns the “default value” for a type.

impl From<BlockNumberOrTag> for FilterBlockOption

fn from(block: BlockNumberOrTag) -> FilterBlockOption

Converts to this type from the input type.

impl From<FixedBytes<32>> for FilterBlockOption

fn from(hash: FixedBytes<32>) -> FilterBlockOption

Converts to this type from the input type.

impl<T> From<RangeFrom<T>> for FilterBlockOption

where T: Into<BlockNumberOrTag>,

fn from(r: RangeFrom<T>) -> FilterBlockOption

Converts to this type from the input type.

impl<T> From<RangeInclusive<T>> for FilterBlockOption

where T: Into<BlockNumberOrTag>,

fn from(r: RangeInclusive<T>) -> FilterBlockOption

Converts to this type from the input type.

impl<T> From<RangeToInclusive<T>> for FilterBlockOption

where T: Into<BlockNumberOrTag>,

fn from(r: RangeToInclusive<T>) -> FilterBlockOption

Converts to this type from the input type.

impl From<Uint<64, 1>> for FilterBlockOption

fn from(block: Uint<64, 1>) -> FilterBlockOption

Converts to this type from the input type.

impl From<u64> for FilterBlockOption

fn from(block: u64) -> FilterBlockOption

Converts to this type from the input type.

impl Hash for FilterBlockOption

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FilterBlockOption

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

impl Eq for FilterBlockOption

impl StructuralPartialEq for FilterBlockOption

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 40 bytes

Size for each variant:

• Range: 39 bytes
• AtBlockHash: 32 bytes