Struct BufferedContext 

pub struct BufferedContext<S: Service> { /* private fields */ }

A buffered service context.

This ServiceContext implementation is a wrapper around a service that provides a mailbox for input events and a mailbox for output events. The mailboxes are implemented as FIFO queues based on VecDeque.

The input mailbox acts as a buffer for the events that are sent to the service. The events are enqueued into the mailbox by calling the do_send method. The mailbox events are processed by the service on the next BufferedContext::poll call (see poll for more details).

The service context implements Deref trait to the inner service, so it can be used as the wrapped service itself.

Implementations

impl<S: Service> BufferedContext<S>

Public API,

pub fn new(service: S) -> Self

Create a new service context for the given service.

pub fn service(&self) -> &S

Get a reference to the inner service.

Trait Implementations

impl<S: Service + Default> Default for BufferedContext<S>

fn default() -> Self

Returns the “default value” for a type.

impl<S: Service> Deref for BufferedContext<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S: Service> ServiceContext for BufferedContext<S>

fn do_send(&mut self, ev: S::InEvent)

Sends a message unconditionally, ignoring any potential errors.

The event will be enqueued into the service input mailbox and will be processed by the service on the next BufferedContext::poll call. See poll for more details.

fn poll(&mut self, cx: &mut TaskContext<'_>) -> Poll<S::OutEvent>

Poll the service for events.

The service polling process consists of the following steps:

1. Poll the service for events. This triggers the Service::poll method, allowing the service to emit events.

   If the poll method returns a Poll::Ready event, the polling process will stop any further polling and the event will be returned to the downstream service.

2. Process all the service output mailbox events. This drains the output mailbox and returns the events to the downstream service.

type InEvent = <S as Service>::InEvent

The input event type.

type OutEvent = <S as Service>::OutEvent

The output event type.