Struct vtubestudio::service::ApiService

pub struct ApiService<T>
where
    T: Sink<RequestEnvelope> + TryStream<Ok = ResponseEnvelope>,
{ /* private fields */ }

A Service that assigns request IDs to RequestEnvelopes and matches them to incoming ResponseEnvelopes.

This uses tokio_tower::multiplex to wrap an underlying transport.

Implementations

impl<T> ApiService<T>

where T: Sink<RequestEnvelope> + TryStream<Ok = ResponseEnvelope> + Send + 'static, <T as TryStream>::Error: Send, BoxError: From<<T as Sink<RequestEnvelope>>::Error> + From<<T as TryStream>::Error>,

pub fn new(transport: T, buffer_size: usize) -> (Self, EventStream<T>)

Create a new ApiService and corresponding EventStream.

pub fn with_error_handler<F>( transport: T, buffer_size: usize, on_service_error: F, ) -> (Self, EventStream<T>)

where F: FnOnce(Error) + Send + 'static,

Create a new ApiService with an internal handler for transport errors.

Trait Implementations

impl<T> Debug for ApiService<T>

where T: Sink<RequestEnvelope> + TryStream<Ok = ResponseEnvelope> + Debug,

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

Formats the value using the given formatter.

impl<T> Service<RequestEnvelope> for ApiService<T>

where T: Sink<RequestEnvelope> + TryStream<Ok = ResponseEnvelope> + 'static, BoxError: From<<T as Sink<RequestEnvelope>>::Error> + From<<T as TryStream>::Error>,

type Response = ResponseEnvelope

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<ApiService<T> as Service<RequestEnvelope>>::Response, <ApiService<T> as Service<RequestEnvelope>>::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, req: RequestEnvelope) -> Self::Future

Process the request and return the response asynchronously.