Struct tower::make::Shared[][src]

pub struct Shared<S> { /* fields omitted */ }
This is supported on crate feature make only.
Expand description

A MakeService that produces services by cloning an inner service.

Example

use tower::make::{MakeService, Shared};
use tower::buffer::Buffer;
use tower::Service;
use futures::future::{Ready, ready};

// An example connection type
struct Connection {}

// An example request type
struct Request {}

// An example response type
struct Response {}

// Some service that doesn't implement `Clone`
struct MyService;

impl Service<Request> for MyService {
    type Response = Response;
    type Error = Infallible;
    type Future = Ready<Result<Response, Infallible>>;

    fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Poll::Ready(Ok(()))
    }

    fn call(&mut self, req: Request) -> Self::Future {
        ready(Ok(Response {}))
    }
}

// Example function that runs a service by accepting new connections and using
// `Make` to create new services that might be bound to the connection.
//
// This is similar to what you might find in hyper.
async fn serve_make_service<Make>(make: Make)
where
    Make: MakeService<Connection, Request>
{
    // ...
}

// Our service
let svc = MyService;

// Make it `Clone` by putting a channel in front
let buffered = Buffer::new(svc, 1024);

// Convert it into a `MakeService`
let make = Shared::new(buffered);

// Run the service and just ignore the `Connection`s as `MyService` doesn't need them
serve_make_service(make).await;

Implementations

impl<S> Shared<S>[src]

pub fn new(service: S) -> Self[src]

Create a new Shared from a service.

Trait Implementations

impl<S: Clone> Clone for Shared<S>[src]

fn clone(&self) -> Shared<S>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<S: Debug> Debug for Shared<S>[src]

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

Formats the value using the given formatter. Read more

impl<S, T> Service<T> for Shared<S> where
    S: Clone
[src]

type Response = S

Responses given by the service.

type Error = Infallible

Errors produced by the service.

type Future = SharedFuture<S>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>[src]

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

fn call(&mut self, _target: T) -> Self::Future[src]

Process the request and return the response asynchronously. Read more

impl<S: Copy> Copy for Shared<S>[src]

Auto Trait Implementations

impl<S> RefUnwindSafe for Shared<S> where
    S: RefUnwindSafe

impl<S> Send for Shared<S> where
    S: Send

impl<S> Sync for Shared<S> where
    S: Sync

impl<S> Unpin for Shared<S> where
    S: Unpin

impl<S> UnwindSafe for Shared<S> where
    S: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, Request> ServiceExt<Request> for T where
    T: Service<Request> + ?Sized
[src]

fn ready(&mut self) -> Ready<'_, Self, Request>

Notable traits for Ready<'a, T, Request>

impl<'a, T, Request> Future for Ready<'a, T, Request> where
    T: Service<Request>, 
type Output = Result<&'a mut T, T::Error>;
where
    Self: Sized
[src]

This is supported on crate feature util only.

Yields a mutable reference to the service when it is ready to accept a request.

fn ready_and(&mut self) -> ReadyAnd<'_, Self, Request> where
    Self: Sized
[src]

👎 Deprecated since 0.4.6:

please use the ServiceExt::ready method instead

This is supported on crate feature util only.

Yields a mutable reference to the service when it is ready to accept a request.

fn ready_oneshot(self) -> ReadyOneshot<Self, Request>

Notable traits for ReadyOneshot<T, Request>

impl<T, Request> Future for ReadyOneshot<T, Request> where
    T: Service<Request>, 
type Output = Result<T, T::Error>;
where
    Self: Sized
[src]

This is supported on crate feature util only.

Yields the service when it is ready to accept a request.

fn oneshot(self, req: Request) -> Oneshot<Self, Request>

Notable traits for Oneshot<S, Req>

impl<S, Req> Future for Oneshot<S, Req> where
    S: Service<Req>, 
type Output = Result<S::Response, S::Error>;
where
    Self: Sized
[src]

This is supported on crate feature util only.

Consume this Service, calling with the providing request once it is ready.

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
    Self: Sized,
    Self::Error: Into<BoxError>,
    S: Stream<Item = Request>, 
[src]

This is supported on crate feature util only.

Process all requests from the given Stream, and produce a Stream of their responses. Read more

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
    Self: Sized,
    F: Clone
[src]

This is supported on crate feature util only.

Executes a new future after this service’s future resolves. This does not alter the behaviour of the poll_ready method. Read more

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
    Self: Sized,
    F: FnOnce(Self::Response) -> Response + Clone
[src]

This is supported on crate feature util only.

Maps this service’s response value to a different value. This does not alter the behaviour of the poll_ready method. Read more

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
    Self: Sized,
    F: FnOnce(Self::Error) -> Error + Clone
[src]

This is supported on crate feature util only.

Maps this service’s error value to a different value. This does not alter the behaviour of the poll_ready method. Read more

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
    Self: Sized,
    Error: From<Self::Error>,
    F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone
[src]

This is supported on crate feature util only.

Maps this service’s result type (Result<Self::Response, Self::Error>) to a different value, regardless of whether the future succeeds or fails. Read more

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
    Self: Sized,
    F: FnMut(NewRequest) -> Request + Clone
[src]

This is supported on crate feature util only.

Composes a function in front of the service. Read more

fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F> where
    Self: Sized,
    F: Predicate<NewRequest>, 
[src]

This is supported on crate features util and filter only.

Composes this service with a Filter that conditionally accepts or rejects requests based on a predicate. Read more

fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F> where
    Self: Sized,
    F: AsyncPredicate<NewRequest>, 
[src]

This is supported on crate features util and filter only.

Composes this service with an AsyncFilter that conditionally accepts or rejects requests based on an [async predicate]. Read more

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
    Self: Sized,
    Error: From<Self::Error>,
    F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
    Fut: Future<Output = Result<Response, Error>>, 
[src]

This is supported on crate feature util only.

Composes an asynchronous function after this service. Read more

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
    Self: Sized,
    F: FnMut(Self::Future) -> Fut,
    Error: From<Self::Error>,
    Fut: Future<Output = Result<Response, Error>>, 
[src]

This is supported on crate feature util only.

Composes a function that transforms futures produced by the service. Read more

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V