Struct trillium_http::Upgrade[−][src]

pub struct Upgrade<Transport> {
    pub request_headers: Headers,
    pub path: String,
    pub method: Method,
    pub state: Extensions,
    pub transport: Transport,
    pub buffer: Option<Vec<u8>>,
    pub stopper: Stopper,
}

Expand description

This open (pub fields) struct represents a http upgrade. It contains all of the data available on a Conn, as well as owning the underlying transport.

Important implementation note: When reading directly from the transport, ensure that you read from buffer first if there are bytes in it. Alternatively, read directly from the Upgrade, as that AsyncRead implementation will drain the buffer first before reading from the transport.

Fields

request_headers: Headers

The http request headers

path: String

The request path

method: Method

The http request method

state: Extensions

Any state that has been accumulated on the Conn before negotiating the upgrade

transport: Transport

The underlying io (often a TcpStream or similar)

buffer: Option<Vec<u8>>

Any bytes that have been read from the underlying tcpstream already. It is your responsibility to process these bytes before reading directly from the transport.

stopper: Stopper

A Stopper which can and should be used to gracefully shut down any long running streams or futures associated with this upgrade

Implementations

impl<Transport> Upgrade<Transport>

pub fn headers(&self) -> &Headers

read-only access to the request headers

pub fn path(&self) -> &str

the http request path

pub fn method(&self) -> &Method

the http method

pub fn state(&self) -> &Extensions

any state that has been accumulated on the Conn before negotiating the upgrade.

pub fn map_transport<T: AsyncRead + AsyncWrite + Send + Sync + Unpin + 'static>(
    self, 
    f: impl Fn(Transport) -> T
) -> Upgrade<T>

Modify the transport type of this upgrade. This is useful for boxing the transport in order to erase the type argument.

Trait Implementations

impl<Transport: AsyncRead + Unpin> AsyncRead for Upgrade<Transport>

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

Attempt to read from the AsyncRead into buf. Read more

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

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

impl<Transport: AsyncWrite + Unpin> AsyncWrite for Upgrade<Transport>

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

Attempt to write bytes from buf into the object. Read more

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. Read more

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

Attempt to close the object. Read more

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

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

impl<Transport> Debug for Upgrade<Transport>

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

Formats the value using the given formatter. Read more

impl<Transport> From<Conn<Transport>> for Upgrade<Transport>

fn from(conn: Conn<Transport>) -> Self

Performs the conversion.

Auto Trait Implementations

impl<Transport> !RefUnwindSafe for Upgrade<Transport>

impl<Transport> Send for Upgrade<Transport> where
    Transport: Send,

impl<Transport> Sync for Upgrade<Transport> where
    Transport: Sync,

impl<Transport> Unpin for Upgrade<Transport> where
    Transport: Unpin,

impl<Transport> !UnwindSafe for Upgrade<Transport>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<R> AsyncReadExt for R where
    R: AsyncRead + ?Sized,

fn read(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self> where
    Self: Unpin,

Reads some bytes from the byte stream. Read more

fn read_vectored(
    &'a mut self, 
    bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
    Self: Unpin,

Like read(), except it reads into a slice of buffers. Read more

fn read_to_end(
    &'a mut self, 
    buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
    Self: Unpin,

Reads the entire contents and appends them to a Vec. Read more

fn read_to_string(
    &'a mut self, 
    buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
    Self: Unpin,

Reads the entire contents and appends them to a String. Read more

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self> where
    Self: Unpin,

Reads the exact number of bytes required to fill buf. Read more

fn take(self, limit: u64) -> Take<Self>

Creates an adapter which will read at most limit bytes from it. Read more

fn bytes(self) -> Bytes<Self>

Converts this [AsyncRead] into a [Stream] of bytes. Read more

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: AsyncRead,

Creates an adapter which will chain this stream with another. Read more

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a, Global>> where
    Self: Send + 'a,

Boxes the reader and changes its type to dyn AsyncRead + Send + 'a. Read more

impl<W> AsyncWriteExt for W where
    W: AsyncWrite + ?Sized,

fn write(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self> where
    Self: Unpin,

Writes some bytes into the byte stream. Read more

fn write_vectored(
    &'a mut self, 
    bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self> where
    Self: Unpin,

Like write(), except that it writes a slice of buffers. Read more

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self> where
    Self: Unpin,

Writes an entire buffer into the byte stream. Read more

fn flush(&mut self) -> FlushFuture<'_, Self> where
    Self: Unpin,

Flushes the stream to ensure that all buffered contents reach their destination. Read more

fn close(&mut self) -> CloseFuture<'_, Self> where
    Self: Unpin,

Closes the writer. Read more

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>> where
    Self: Send + 'a,

Boxes the writer and changes its type to dyn AsyncWrite + Send + 'a. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

impl<T> Transport for T where
    T: Any + AsyncRead + AsyncWrite + Send + Sync + Unpin,

pub fn as_box_any(Box<T, Global>) -> Box<dyn Any + 'static, Global>

in order to support downcasting from a Box<dyn Transport>, Transport requires implementing an as_box_any function. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V