Struct PayloadBuilderHandle

pub struct PayloadBuilderHandle<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>>) -> Self

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.

Trait Implementations

impl<T> Clone for PayloadBuilderHandle<T>

where T: PayloadTypes,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + PayloadTypes> Debug for PayloadBuilderHandle<T>

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

Formats the value using the given formatter.

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

where T: PayloadTypes,

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

Converts to this type from the input type.

impl<T> PayloadBuilder for PayloadBuilderHandle<T>

where T: PayloadTypes,

fn best_payload<'life0, 'async_trait>( &'life0 self, id: PayloadId, ) -> Pin<Box<dyn Future<Output = Option<Result<<Self::PayloadType as PayloadTypes>::BuiltPayload, Self::Error>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Note: this does not resolve the job if it’s still in progress.

fn payload_attributes<'life0, 'async_trait>( &'life0 self, id: PayloadId, ) -> Pin<Box<dyn Future<Output = Option<Result<T::PayloadBuilderAttributes, PayloadBuilderError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the payload attributes associated with the given identifier.

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

type PayloadType = T

The Payload type for the builder.

type Error = PayloadBuilderError

The error type returned by the builder.

fn send_new_payload( &self, attr: <Self::PayloadType as PayloadTypes>::PayloadBuilderAttributes, ) -> Receiver<Result<PayloadId, Self::Error>>

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

fn resolve_kind<'life0, 'async_trait>( &'life0 self, id: PayloadId, kind: PayloadKind, ) -> Pin<Box<dyn Future<Output = Option<Result<T::BuiltPayload, PayloadBuilderError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn subscribe<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<PayloadEvents<Self::PayloadType>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn resolve<'life0, 'async_trait>( &'life0 self, id: PayloadId, ) -> Pin<Box<dyn Future<Output = Option<Result<<Self::PayloadType as PayloadTypes>::BuiltPayload, Self::Error>>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

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

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