Enum MiningMode 

pub enum MiningMode<Pool>
where
    Pool: TransactionPool + Unpin,
{
    Instant {
        pool: Pool,
        rx: Fuse<ReceiverStream<FixedBytes<32>>>,
        max_transactions: Option<usize>,
        accumulated: usize,
    },
    Interval(Interval),
    Trigger(Pin<Box<dyn Stream<Item = ()> + Sync + Send>>),
}

Available on crate feature node only.

A mining mode for the local dev engine.

Variants

Instant

In this mode a block is built as soon as a valid transaction reaches the pool. If max_transactions is set, a block is built when that many transactions have accumulated.

Fields

pool: Pool

The transaction pool.

rx: Fuse<ReceiverStream<FixedBytes<32>>>

Stream of transaction notifications.

max_transactions: Option<usize>

Maximum number of transactions to accumulate before mining a block. If None, mine immediately when any transaction arrives.

accumulated: usize

Counter for accumulated transactions (only used when max_transactions is set).

Interval(Interval)

In this mode a block is built at a fixed interval.

Trigger(Pin<Box<dyn Stream<Item = ()> + Sync + Send>>)

In this mode a block is built when the trigger stream yields a value.

This is a general-purpose trigger that can be fired on demand, for example via a channel or any other [Stream] implementation.

Implementations

impl<Pool> MiningMode<Pool>

where Pool: TransactionPool + Unpin,

pub fn instant(pool: Pool, max_transactions: Option<usize>) -> MiningMode<Pool>

Constructor for a MiningMode::Instant

pub fn interval(duration: Duration) -> MiningMode<Pool>

Constructor for a MiningMode::Interval

pub fn trigger( trigger: impl Stream<Item = ()> + Send + Sync + 'static, ) -> MiningMode<Pool>

Constructor for a MiningMode::Trigger

Accepts any stream that yields () values, each of which triggers a new block to be mined. This can be backed by a channel, a custom stream, or any other async source.

Trait Implementations

impl<Pool> Debug for MiningMode<Pool>

where Pool: TransactionPool + Unpin,

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

Formats the value using the given formatter.

impl<Pool> Future for MiningMode<Pool>

where Pool: TransactionPool + Unpin,

type Output = ()

The type of value produced on completion.

fn poll( self: Pin<&mut MiningMode<Pool>>, cx: &mut Context<'_>, ) -> Poll<<MiningMode<Pool> as Future>::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.