Struct Upgrade 

pub struct Upgrade(/* private fields */);

A HTTP protocol upgrade

Implementations

impl Upgrade

pub fn request_headers(&self) -> &Headers

Borrows the HTTP request headers

pub fn take_request_headers(&mut self) -> Headers

Take the HTTP request headers

pub fn method(&self) -> Method

Returns a copy of the HTTP request method

pub fn state(&self) -> &TypeSet

Borrows the state accumulated on the Conn before negotiating the upgrade

pub fn take_state(&mut self) -> TypeSet

Takes the TypeSet accumulated on the Conn before negotiating the upgrade

pub fn state_mut(&mut self) -> &mut TypeSet

Mutably borrow the TypeSet accumulated on the Conn before negotiating the upgrade

pub fn transport(&self) -> &dyn Transport

Borrows the underlying transport

pub fn transport_mut(&mut self) -> (&[u8], &mut dyn Transport)

Mutably borrow the underlying transport

This returns a tuple of (buffered bytes, transport) in order to make salient the requirement to handle any buffered bytes before using the transport directly.

pub fn into_transport(self) -> (Vec<u8>, Box<dyn Transport>)

Consumes self, returning the underlying transport

This returns a tuple of (buffered bytes, transport) in order to make salient the requirement to handle any buffered bytes before using the transport directly.

pub fn peer_ip(&self) -> Option<IpAddr>

Returns a copy of the peer IP address of the connection, if available

pub fn authority(&self) -> Option<&str>

Borrows the :authority HTTP/3 pseudo-header

pub fn scheme(&self) -> Option<&str>

Borrows the :scheme HTTP/3 pseudo-header

pub fn protocol(&self) -> Option<&str>

Borrows the :protocol HTTP/3 pseudo-header

pub fn http_version(&self) -> &Version

Borrows the HTTP version

pub fn is_secure(&self) -> bool

Returns a copy of whether this connection was deemed secure by the handler stack

pub fn shared_state(&self) -> &TypeSet

Borrows the shared state TypeSet for this application

pub fn path(&self) -> &str

Returns the HTTP request path up to but excluding any query component

pub fn querystring(&self) -> &str

Retrieves the query component of the path

pub fn swansong(&self) -> Swansong

Retrieves a cloned Swansong graceful shutdown controller

pub fn context(&self) -> Arc<HttpContext>

Retrieves a clone of the HttpContext for this upgrade

pub fn h3_connection(&self) -> Option<Arc<H3Connection>>

Returns a clone of the H3 connection, if any

Trait Implementations

impl AsyncRead for Upgrade

where Self: Unpin,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for Upgrade

where Self: Unpin,

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for Upgrade

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

Formats the value using the given formatter.

impl<T: Transport + 'static> From<Conn<T>> for Upgrade

fn from(value: Conn<T>) -> Self

Converts to this type from the input type.

impl From<Conn> for Upgrade

fn from(value: Conn) -> Self

Converts to this type from the input type.

impl<T: Transport + 'static> From<Upgrade<T>> for Upgrade

fn from(value: Upgrade<T>) -> Self

Converts to this type from the input type.