Struct rama::http::server::HttpServer
pub struct HttpServer<B> { /* private fields */ }
Expand description
A builder for configuring and listening over HTTP using a Service
.
Supported Protocols: HTTP/1, H2, Auto (HTTP/1 + H2)
Implementations§
§impl HttpServer<Builder>
impl HttpServer<Builder>
pub fn http1() -> HttpServer<Builder>
pub fn http1() -> HttpServer<Builder>
Create a new http/1.1 Builder
with default settings.
§impl HttpServer<Builder>
impl HttpServer<Builder>
pub fn http1_mut(&mut self) -> Http1Config<'_>
pub fn http1_mut(&mut self) -> Http1Config<'_>
Http1 configuration.
§impl HttpServer<Builder<HyperExecutor>>
impl HttpServer<Builder<HyperExecutor>>
pub fn h2(exec: Executor) -> HttpServer<Builder<HyperExecutor>>
pub fn h2(exec: Executor) -> HttpServer<Builder<HyperExecutor>>
Create a new h2 Builder
with default settings.
§impl<E> HttpServer<Builder<E>>
impl<E> HttpServer<Builder<E>>
§impl HttpServer<Builder<HyperExecutor>>
impl HttpServer<Builder<HyperExecutor>>
pub fn auto(exec: Executor) -> HttpServer<Builder<HyperExecutor>>
pub fn auto(exec: Executor) -> HttpServer<Builder<HyperExecutor>>
Create a new dual http/1.1 + h2 Builder
with default settings.
§impl<E> HttpServer<Builder<E>>
impl<E> HttpServer<Builder<E>>
pub fn http1_mut(&mut self) -> AutoHttp1Config<'_, E>
pub fn http1_mut(&mut self) -> AutoHttp1Config<'_, E>
Http1 configuration.
pub fn h2_mut(&mut self) -> AutoH2Config<'_, E>
pub fn h2_mut(&mut self) -> AutoH2Config<'_, E>
H2 configuration.
§impl<B> HttpServer<B>where
B: HyperConnServer,
impl<B> HttpServer<B>where
B: HyperConnServer,
pub fn service<S>(self, service: S) -> HttpService<B, S>
pub fn service<S>(self, service: S) -> HttpService<B, S>
Turn this HttpServer
into a Service
that can be used to serve
IO Byte streams (e.g. a TCP Stream) as HTTP.
pub async fn serve<State, S, Response, IO>(
&self,
ctx: Context<State>,
stream: IO,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
State: Clone + Send + Sync + 'static,
S: Service<State, Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
IO: Stream,
pub async fn serve<State, S, Response, IO>(
&self,
ctx: Context<State>,
stream: IO,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
State: Clone + Send + Sync + 'static,
S: Service<State, Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
IO: Stream,
Serve a single IO Byte Stream (e.g. a TCP Stream) as HTTP.
pub async fn listen<S, Response, A>(
self,
addr: A,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
S: Service<(), Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
A: ToSocketAddrs,
pub async fn listen<S, Response, A>(
self,
addr: A,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
S: Service<(), Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
A: ToSocketAddrs,
Listen for connections on the given address, serving HTTP connections.
It’s a shortcut in case you don’t need to operate on the transport layer directly.
pub async fn listen_graceful<S, Response, A>(
self,
guard: ShutdownGuard,
addr: A,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
S: Service<(), Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
A: ToSocketAddrs,
pub async fn listen_graceful<S, Response, A>(
self,
guard: ShutdownGuard,
addr: A,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
S: Service<(), Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
A: ToSocketAddrs,
Listen gracefully for connections on the given address, serving HTTP connections.
Same as Self::listen
, but it will respect the given ShutdownGuard
,
and also pass it to the service.
pub async fn listen_with_state<State, S, Response, A>(
self,
state: State,
addr: A,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
State: Clone + Send + Sync + 'static,
S: Service<State, Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
A: ToSocketAddrs,
pub async fn listen_with_state<State, S, Response, A>(
self,
state: State,
addr: A,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
State: Clone + Send + Sync + 'static,
S: Service<State, Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
A: ToSocketAddrs,
Listen for connections on the given address, serving HTTP connections.
Same as Self::listen
, but including the given state in the Service
’s Context
.
pub async fn listen_graceful_with_state<State, S, Response, A>(
self,
guard: ShutdownGuard,
state: State,
addr: A,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
State: Clone + Send + Sync + 'static,
S: Service<State, Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
A: ToSocketAddrs,
pub async fn listen_graceful_with_state<State, S, Response, A>(
self,
guard: ShutdownGuard,
state: State,
addr: A,
service: S,
) -> Result<(), Box<dyn Error + Send + Sync>>where
State: Clone + Send + Sync + 'static,
S: Service<State, Request<Body>, Response = Response, Error = Infallible>,
Response: IntoResponse + Send + 'static,
A: ToSocketAddrs,
Listen gracefully for connections on the given address, serving HTTP connections.
Same as Self::listen_graceful
, but including the given state in the Service
’s Context
.
Trait Implementations§
§impl<B> Clone for HttpServer<B>where
B: Clone,
impl<B> Clone for HttpServer<B>where
B: Clone,
§fn clone(&self) -> HttpServer<B>
fn clone(&self) -> HttpServer<B>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl<B> Freeze for HttpServer<B>where
B: Freeze,
impl<B> RefUnwindSafe for HttpServer<B>where
B: RefUnwindSafe,
impl<B> Send for HttpServer<B>where
B: Send,
impl<B> Sync for HttpServer<B>where
B: Sync,
impl<B> Unpin for HttpServer<B>where
B: Unpin,
impl<B> UnwindSafe for HttpServer<B>where
B: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<S, P, B, E>(self, other: P) -> And<T, P>
fn and<S, P, B, E>(self, other: P) -> And<T, P>
Policy
that returns Action::Follow
only if self
and other
return
Action::Follow
. Read more§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.