Skip to main content

EffectfulLayeredServer

Struct EffectfulLayeredServer 

Source
pub struct EffectfulLayeredServer<A: ApiSpec, Provided, S> { /* private fields */ }
Expand description

An effectful server with Tower middleware layers applied.

Created by EffectfulServer::layer. Supports further .provide(), .layer(), and .serve() calls.

Implementations§

Source§

impl<A: ApiSpec, P, S> EffectfulLayeredServer<A, P, S>

Source

pub fn provide<E: Effect>(self) -> EffectfulLayeredServer<A, ECons<E, P>, S>

Declare that a middleware effect has been provided.

Source

pub fn with_state<T: Clone + Send + Sync + 'static>(self, state: T) -> Self

Add shared state accessible via State<T> extractors.

Source

pub fn max_body_size(self, max: usize) -> Self

Set the maximum request body size.

Source

pub fn nest(self, prefix: &str) -> Self

Set a path prefix for all routes.

Source§

impl<A: ApiSpec, P, S> EffectfulLayeredServer<A, P, S>
where S: Service<Request<Incoming>, Response = Response<BoxBody>, Error = Infallible> + Clone + Send + 'static, S::Future: Send + 'static,

Source

pub fn layer<L>(self, layer: L) -> EffectfulLayeredServer<A, P, L::Service>
where L: Layer<S>, L::Service: Service<Request<Incoming>, Response = Response<BoxBody>, Error = Infallible> + Clone + Send + 'static, <L::Service as Service<Request<Incoming>>>::Future: Send + 'static,

Apply another Tower middleware layer.

Source§

impl<A: ApiSpec, P, S> EffectfulLayeredServer<A, P, S>
where S: Service<Request<Incoming>, Response = Response<BoxBody>, Error = Infallible> + Clone + Send + 'static, S::Future: Send + 'static,

Source

pub fn ready<Idx>(self) -> LayeredServer<S>
where A: AllProvided<P, Idx>,

Finalize into a LayeredServer.

Only compiles if all required effects have been provided.

Source

pub async fn serve<Idx>( self, addr: SocketAddr, ) -> Result<(), Box<dyn Error + Send + Sync>>
where A: AllProvided<P, Idx>,

Start serving HTTP requests.

Only compiles if all required effects have been provided.

Source

pub async fn serve_with_shutdown<Idx>( self, listener: TcpListener, shutdown: impl Future<Output = ()> + Send, ) -> Result<(), Box<dyn Error + Send + Sync>>
where A: AllProvided<P, Idx>,

Start serving with graceful shutdown.

Only compiles if all required effects have been provided.

Auto Trait Implementations§

§

impl<A, Provided, S> Freeze for EffectfulLayeredServer<A, Provided, S>
where S: Freeze,

§

impl<A, Provided, S> !RefUnwindSafe for EffectfulLayeredServer<A, Provided, S>

§

impl<A, Provided, S> Send for EffectfulLayeredServer<A, Provided, S>
where S: Send, A: Send, Provided: Send,

§

impl<A, Provided, S> Sync for EffectfulLayeredServer<A, Provided, S>
where S: Sync, A: Sync, Provided: Sync,

§

impl<A, Provided, S> Unpin for EffectfulLayeredServer<A, Provided, S>
where S: Unpin, A: Unpin, Provided: Unpin,

§

impl<A, Provided, S> UnsafeUnpin for EffectfulLayeredServer<A, Provided, S>
where S: UnsafeUnpin,

§

impl<A, Provided, S> !UnwindSafe for EffectfulLayeredServer<A, Provided, S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<B, C, R, H> Serves<VersionedApi<B, C, R>> for H
where R: ApiSpec, H: Serves<R>,

Source§

fn register(self, router: &mut Router)

Register all handlers into the router.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> IsEndpoint<T> for T