Struct PayloadBuilderHandle 

pub struct PayloadBuilderHandle<T>
where
    T: PayloadTypes,
{ /* private fields */ }

A communication channel to the PayloadBuilderService.

This is the API used to create new payloads and to get the current state of existing ones.

Implementations

impl<T> PayloadBuilderHandle<T>

where T: PayloadTypes,

pub const fn new( to_service: UnboundedSender<PayloadServiceCommand<T>>, ) -> PayloadBuilderHandle<T>

Creates a new payload builder handle for the given channel.

Note: this is only used internally by the PayloadBuilderService to manage the payload building flow See PayloadBuilderService::poll for implementation details.

pub fn send_new_payload( &self, input: BuildNewPayload<<T as PayloadTypes>::PayloadAttributes>, ) -> Receiver<Result<PayloadId, PayloadBuilderError>>

Sends a message to the service to start building a new payload for the given payload.

Returns a receiver that will receive the payload id.

pub async fn best_payload( &self, id: PayloadId, ) -> Option<Result<<T as PayloadTypes>::BuiltPayload, PayloadBuilderError>>

Returns the best payload for the given identifier. Note: this does not resolve the job if it’s still in progress.

pub fn resolve_kind( &self, id: PayloadId, kind: PayloadKind, ) -> impl Future<Output = Option<Result<<T as PayloadTypes>::BuiltPayload, PayloadBuilderError>>>

Resolves the payload job and returns the best payload that has been built so far.

Cancellation safety

The future returned by this method is not cancellation-safe. This method sends the resolve command before returning the future, so dropping the returned future drops the response receiver and cancels the job identified by id.

pub async fn subscribe(&self) -> Result<PayloadEvents<T>, PayloadBuilderError>

Sends a message to the service to subscribe to payload events. Returns a receiver that will receive them.

pub async fn payload_timestamp( &self, id: PayloadId, ) -> Option<Result<u64, PayloadBuilderError>>

Returns the payload timestamp associated with the given identifier.

Note: this returns the timestamp of the payload and does not resolve the job.

impl<T> PayloadBuilderHandle<T>

where T: PayloadTypes,

pub fn noop() -> PayloadBuilderHandle<T>

Returns a new noop instance.

Trait Implementations

impl<T> Clone for PayloadBuilderHandle<T>

where T: PayloadTypes,

fn clone(&self) -> PayloadBuilderHandle<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PayloadBuilderHandle<T>

where T: Debug + PayloadTypes,

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

Formats the value using the given formatter.

impl<T> From<PayloadBuilderHandle<T>> for PayloadStore<T>

where T: PayloadTypes,

fn from(inner: PayloadBuilderHandle<T>) -> PayloadStore<T>

Converts to this type from the input type.

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: 8 bytes