Skip to main content

Http2

Struct Http2 

Source
pub struct Http2<Io> { /* private fields */ }
Available on crate feature h2 only.
Expand description

An HTTP/2 connection handler.

Http2 wraps an async I/O stream (Io) and drives the HTTP/2 server connection using the h2 crate. It supports:

  • Concurrent request stream handling
  • Streaming request/response bodies and trailers
  • Automatic 100 Continue and 103 Early Hints interim responses
  • Per-connection Date header caching
  • Graceful shutdown via a CancellationToken

§Construction

let http2 = Http2::new(tcp_stream, Http2Options::default());

§Serving requests

Use the HttpProtocol trait methods (handle / handle_with_error_fn) to drive the connection to completion.

Implementations§

Source§

impl<Io> Http2<Io>
where Io: AsyncRead + AsyncWrite + Unpin + 'static,

Source

pub fn new(io: Io, options: Http2Options) -> Self

Creates a new Http2 connection handler wrapping the given I/O stream.

The options value controls HTTP/2 protocol configuration, handshake and accept timeouts, and optional behaviour such as automatic 100 Continue responses; see Http2Options for details.

§Example
let http2 = Http2::new(tcp_stream, Http2Options::default());
Source

pub fn graceful_shutdown_token(self, token: CancellationToken) -> Self

Attaches a CancellationToken for graceful shutdown.

When the token is cancelled, the handler sends HTTP/2 graceful shutdown signals (GOAWAY), stops accepting new streams, and exits cleanly.

Trait Implementations§

Source§

impl<Io> HttpProtocol for Http2<Io>
where Io: AsyncRead + AsyncWrite + Unpin + 'static,

Source§

fn handle<F, Fut, ResB, ResBE, ResE>( self, request_fn: F, ) -> impl Future<Output = Result<(), Error>>
where F: Fn(Request<Incoming>) -> Fut + 'static, Fut: Future<Output = Result<Response<ResB>, ResE>> + 'static, ResB: Body<Data = Bytes, Error = ResBE> + Unpin, ResE: Error, ResBE: Error,

Source§

fn handle_with_error_fn<F, Fut, ResB, ResBE, ResE, EF, EFut, EResB, EResBE, EResE>( self, request_fn: F, error_fn: EF, ) -> impl Future<Output = Result<(), Error>>
where F: Fn(Request<Incoming>) -> Fut + 'static, Fut: Future<Output = Result<Response<ResB>, ResE>> + 'static, ResB: Body<Data = Bytes, Error = ResBE> + Unpin, ResE: Error, ResBE: Error, EF: FnOnce(bool) -> EFut, EFut: Future<Output = Result<Response<EResB>, EResE>>, EResB: Body<Data = Bytes, Error = EResBE> + Unpin, EResE: Error, EResBE: Error,

Auto Trait Implementations§

§

impl<Io> Freeze for Http2<Io>
where Io: Freeze,

§

impl<Io> !RefUnwindSafe for Http2<Io>

§

impl<Io> !Send for Http2<Io>

§

impl<Io> !Sync for Http2<Io>

§

impl<Io> Unpin for Http2<Io>
where Io: Unpin,

§

impl<Io> UnsafeUnpin for Http2<Io>
where Io: UnsafeUnpin,

§

impl<Io> !UnwindSafe for Http2<Io>

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<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