Struct ethers::types::Filter

pub struct Filter {
    pub block_option: FilterBlockOption,
    pub topics: [Option<ValueOrArray<H256>>; 4],
    // some fields omitted
}

Filter for

Fields

block_option: FilterBlockOption

Filter block options, specifying on which blocks the filter should match.

topics: [Option<ValueOrArray<H256>>; 4]

Topics

Implementations

impl Filter

pub fn new() -> Filter

pub fn select(self, filter: impl Into<FilterBlockOption>) -> Filter

Sets the inner filter object

NOTE: ranges are always inclusive

Examples

Match only a specific block

let filter = Filter::new().select(69u64);

This is the same as Filter::new().from_block(1337u64).to_block(1337u64)

Match the latest block only

let filter = Filter::new().select(BlockNumber::Latest);

Match a block by its hash

let filter = Filter::new().select(H256::zero());

This is the same as at_block_hash

Match a range of blocks

let filter = Filter::new().select(0u64..100u64);

Match all blocks in range (1337..BlockNumber::Latest)

let filter = Filter::new().select(1337u64..);

Match all blocks in range (BlockNumber::Earliest..1337)

let filter = Filter::new().select(..1337u64);

pub fn from_block<T>(self, block: T) -> Filter where
    T: Into<BlockNumber>, 

pub fn to_block<T>(self, block: T) -> Filter where
    T: Into<BlockNumber>, 

pub fn at_block_hash<T>(self, hash: T) -> Filter where
    T: Into<H256>, 

pub fn address<T>(self, address: T) -> Filter where
    T: Into<ValueOrArray<H160>>, 

pub fn event(self, event_name: &str) -> Filter

given the event in string form, it hashes it and adds it to the topics to monitor

pub fn topic0<T>(self, topic: T) -> Filter where
    T: Into<ValueOrArray<H256>>, 

Sets topic0 (the event name for non-anonymous events)

pub fn topic1<T>(self, topic: T) -> Filter where
    T: Into<ValueOrArray<H256>>, 

Sets the 1st indexed topic

pub fn topic2<T>(self, topic: T) -> Filter where
    T: Into<ValueOrArray<H256>>, 

Sets the 2nd indexed topic

pub fn topic3<T>(self, topic: T) -> Filter where
    T: Into<ValueOrArray<H256>>, 

Sets the 3rd indexed topic

pub fn limit(self, limit: usize) -> Filter

Trait Implementations

impl Clone for Filter

pub fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Default for Filter

pub fn default() -> Filter

Returns the “default value” for a type.

impl PartialEq<Filter> for Filter

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

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

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

This method tests for !=.

impl Serialize for Filter

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Filter