Struct vtubestudio::service::MakeApiService

pub struct MakeApiService<M, R> { /* private fields */ }

A Service that yields new ApiServices and EventStreams.

This wraps a MakeTransport (such as TungsteniteConnector), describing how to connect to a websocket sink/stream. This is used for as the inner service for the Reconnect middleware.

Implementations

impl<M, R> MakeApiService<M, R>

where M: MakeTransport<R, RequestEnvelope, Item = ResponseEnvelope>,

pub fn new(maker: M, buffer_size: usize) -> Self

Creates a new MakeApiService.

impl<M, R> MakeApiService<M, R>

pub fn into_inner(self) -> M

Consumes self, returning the inner service.

impl<R> MakeApiService<TungsteniteConnector, R>

where R: Send + IntoClientRequest + Unpin + 'static,

pub fn new_tungstenite(buffer_size: usize) -> Self

Available on crate feature tokio-tungstenite only.

Creates a new MakeApiService using tokio_tungstenite as the underlying transport.

Trait Implementations

impl<M: Clone, R: Clone> Clone for MakeApiService<M, R>

fn clone(&self) -> MakeApiService<M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug, R: Debug> Debug for MakeApiService<M, R>

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

Formats the value using the given formatter.

impl<M, R> Service<R> for MakeApiService<M, R>

where M: MakeTransport<R, RequestEnvelope, Item = ResponseEnvelope> + Send, M::Future: Send + 'static, M::Transport: Send + 'static, M::Error: Send, BoxError: From<M::Error> + From<M::SinkError>,

type Response = (ApiService<<M as MakeTransport<R, RequestEnvelope>>::Transport>, EventStream<<M as MakeTransport<R, RequestEnvelope>>::Transport>)

Responses given by the service.

type Error = <M as MakeTransport<R, RequestEnvelope>>::MakeError

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<MakeApiService<M, R> as Service<R>>::Response, <MakeApiService<M, R> as Service<R>>::Error>> + Send>>

The future response value.

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

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, request: R) -> Self::Future

Process the request and return the response asynchronously.