Struct BaseChannel

pub struct BaseChannel<Req, Resp, T> { /* private fields */ }

BaseChannel is the standard implementation of a Channel.

BaseChannel manages a Transport of client messages and implements a Stream of requests. See the Channel documentation for how to use channels.

Besides requests, the other type of client message handled by BaseChannel is cancellation messages. BaseChannel does not allow direct access to cancellation messages. Instead, it internally handles them by cancelling corresponding requests (removing the corresponding in-flight requests and aborting their handlers).

Implementations

impl<Req, Resp, T> BaseChannel<Req, Resp, T>

where T: Transport<Response<Resp>, ClientMessage<Req>>,

pub fn new(config: Config, transport: T) -> Self

Creates a new channel backed by transport and configured with config.

pub fn with_defaults(transport: T) -> Self

Creates a new channel backed by transport and configured with the defaults.

pub fn get_ref(&self) -> &T

Returns the inner transport over which messages are sent and received.

pub fn get_pin_ref(self: Pin<&mut Self>) -> Pin<&mut T>

Returns the inner transport over which messages are sent and received.

Trait Implementations

impl<Req, Resp, T> AsRef<T> for BaseChannel<Req, Resp, T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<Req, Resp, T> Channel for BaseChannel<Req, Resp, T>

where T: Transport<Response<Resp>, ClientMessage<Req>>,

type Req = Req

Type of request item.

type Resp = Resp

Type of response sink item.

type Transport = T

The wrapped transport.

fn config(&self) -> &Config

Configuration of the channel.

fn in_flight_requests(&self) -> usize

Returns the number of in-flight requests over this channel.

fn transport(&self) -> &Self::Transport

Returns the transport underlying the channel.

fn max_concurrent_requests(self, limit: usize) -> MaxRequests<Self>

where Self: Sized,

Caps the number of concurrent requests to limit. An error will be returned for requests over the concurrency limit.

fn requests(self) -> Requests<Self>

where Self: Sized,

Returns a stream of requests that automatically handle request cancellation and response routing.

fn execute<S>(self, serve: S) -> impl Stream<Item = impl Future<Output = ()>>

where Self: Sized, Self::Req: RequestName, S: Serve<Req = Self::Req, Resp = Self::Resp> + Clone,

Returns a stream of request execution futures. Each future represents an in-flight request being responded to by the server. The futures must be awaited or spawned to complete their requests.

impl<Req, Resp, T> Debug for BaseChannel<Req, Resp, T>

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

Formats the value using the given formatter.

impl<Req, Resp, T> Sink<Response<Resp>> for BaseChannel<Req, Resp, T>

where T: Transport<Response<Resp>, ClientMessage<Req>>, T::Error: Error,

type Error = ChannelError<<T as Sink<Response<Resp>>>::Error>

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, response: Response<Resp>, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<Req, Resp, T> Stream for BaseChannel<Req, Resp, T>

where T: Transport<Response<Resp>, ClientMessage<Req>>,

type Item = Result<TrackedRequest<Req>, ChannelError<<T as Sink<Response<Resp>>>::Error>>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, Req, Resp, T> Unpin for BaseChannel<Req, Resp, T>

where PinnedFieldsOf<__BaseChannel<'pin, Req, Resp, T>>: Unpin,