Struct h2x::Server

source ·
pub struct Server {
    pub listener: Listener,
}
Expand description

The Server represents an HTTP server that listens for incoming connections.

Fields§

§listener: Listener

Listener is responsible for accepting incoming connections.

Implementations§

source§

impl Server

source

pub async fn bind( addr: impl ToSocketAddrs, certs: &mut dyn BufRead, key: &mut dyn BufRead ) -> Result<Self, Box<dyn Error + Send + Sync>>

Binds the Server to the specified address.

source

pub async fn serve_with_graceful_shutdown<State, Stream>( self, on_accept: impl FnOnce(SocketAddr) -> ControlFlow<(), Option<State>> + Clone + 'static, on_stream: fn(_: &mut Conn<TlsStream<TcpStream>>, _: State, _: Request, _: Response) -> Stream ) -> impl Future<Output = ()>where State: Clone + Send + 'static, Stream: Future + Send + 'static,

Graceful shutdown allow existing connections to complete before shutting down the server. It returns a future that resolves when all existing connections have completed.

source

pub async fn serve<State, Stream>( self, on_accept: impl FnOnce(SocketAddr) -> ControlFlow<(), Option<State>> + Clone + 'static, on_stream: fn(_: &mut Conn<TlsStream<TcpStream>>, _: State, _: Request, _: Response) -> Stream )where State: Clone + Send + 'static, Stream: Future + Send + 'static, Stream::Output: Send,

Starts serving incoming connections and handling streams using the provided callbacks.

on_accept

Called once for each accepted connection. This closure that takes a SocketAddr and returns a ControlFlow enum indicating how the server should handle the connection.

The different variants of control-flow are:

  • ControlFlow::Continue(Some(<State>)): Accepts the HTTP connection with the provided state.
  • ControlFlow::Continue(None): Rejects the HTTP connection.
  • ControlFlow::Break(()): Stopping the server from accepting further connections.
on_stream

Called for each stream within a connection and is responsible for processing the stream.

Trait Implementations§

source§

impl From<Listener> for Server

source§

fn from(listener: Listener) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Server

§

impl Send for Server

§

impl Sync for Server

§

impl Unpin for Server

§

impl !UnwindSafe for Server

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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