Struct ethcontract::contract::EventBuilder

#[must_use = "event builders do nothing unless you stream them"]pub struct EventBuilder<T: Transport, E: Detokenize> {
    pub topics: RawTopicFilter,
    pub poll_interval: Option<Duration>,
    // some fields omitted
}

A builder for creating a filtered stream of contract events that are

Fields

topics: RawTopicFilter

The topic filters that are encoded based on the event ABI.

poll_interval: Option<Duration>

The polling interval for querying the node for more events.

Methods

impl<T: Transport, E: Detokenize> EventBuilder<T, E>

pub fn new(web3: Web3<T>, event: AbiEvent, address: Address) -> Self

Creates a new event builder from a web3 provider and a contract event and address.

pub fn from_block(self, block: BlockNumber) -> Self

Sets the starting block from which to stream logs for.

If left unset defaults to the latest block.

pub fn to_block(self, block: BlockNumber) -> Self

Sets the last block from which to stream logs for.

If left unset defaults to the streaming until the end of days.

pub fn limit(self, value: usize) -> Self

Limit the number of events that can be retrieved by this filter.

Note that this parameter is non-standard.

pub fn topic0<P>(self, topic: Topic<P>) -> Self where
    P: Tokenizable, 

Adds a filter for the first indexed topic.

This corresponds to the first indexed property, which for anonymous events corresponds to topic[0] in the log, and for named events is actually topic[1].

pub fn topic1<P>(self, topic: Topic<P>) -> Self where
    P: Tokenizable, 

Adds a filter for the second indexed topic.

pub fn topic2<P>(self, topic: Topic<P>) -> Self where
    P: Tokenizable, 

Adds a filter for the third indexed topic.

pub fn poll_interval(self, value: Duration) -> Self

The polling interval. This is used as the interval between consecutive eth_getFilterChanges calls to get filter updates.

pub fn query(self) -> Result<QueryFuture<T, E>, EventError>

Returns a future that resolves with a collection of all existing logs matching the builder parameters.

pub fn stream(self) -> Result<EventStream<T, E>, EventError>

Creates an event stream from the current event builder that emits new events.