1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
use crate::{Conn, Headers, Method, StateSet, Stopper};
use futures_lite::{AsyncRead, AsyncWrite};
use std::{
fmt::{self, Debug, Formatter},
io,
pin::Pin,
str,
task::{Context, Poll},
};
use trillium_macros::AsyncWrite;
/**
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.
*/
#[derive(AsyncWrite)]
pub struct Upgrade<Transport> {
/// The http request headers
pub request_headers: Headers,
/// The request path
pub path: String,
/// The http request method
pub method: Method,
/// Any state that has been accumulated on the Conn before negotiating the upgrade
pub state: StateSet,
/// The underlying io (often a `TcpStream` or similar)
#[async_write]
pub transport: Transport,
/// 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.
pub buffer: Option<Vec<u8>>,
/// A [`Stopper`] which can and should be used to gracefully shut
/// down any long running streams or futures associated with this
/// upgrade
pub stopper: Stopper,
}
impl<Transport> Upgrade<Transport> {
/// see [`request_headers`]
#[deprecated = "directly access the request_headers field"]
pub fn headers(&self) -> &Headers {
&self.request_headers
}
/// the http request path up to but excluding any query component
pub fn path(&self) -> &str {
match self.path.split_once('?') {
Some((path, _)) => path,
None => &self.path,
}
}
/// retrieves the query component of the path
pub fn querystring(&self) -> &str {
self.path
.split_once('?')
.map(|(_, query)| query)
.unwrap_or_default()
}
/// the http method
pub fn method(&self) -> &Method {
&self.method
}
/// any state that has been accumulated on the Conn before
/// negotiating the upgrade.
pub fn state(&self) -> &StateSet {
&self.state
}
/// Modify the transport type of this upgrade.
///
/// This is useful for boxing the transport in order to erase the type argument.
pub fn map_transport<T: AsyncRead + AsyncWrite + Send + Sync + Unpin + 'static>(
self,
f: impl Fn(Transport) -> T,
) -> Upgrade<T> {
Upgrade {
transport: f(self.transport),
path: self.path,
method: self.method,
state: self.state,
buffer: self.buffer,
request_headers: self.request_headers,
stopper: self.stopper,
}
}
}
impl<Transport> Debug for Upgrade<Transport> {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.debug_struct(&format!("Upgrade<{}>", std::any::type_name::<Transport>()))
.field("request_headers", &self.request_headers)
.field("path", &self.path)
.field("method", &self.method)
.field(
"buffer",
&self.buffer.as_deref().map(String::from_utf8_lossy),
)
.field("stopper", &self.stopper)
.field("state", &self.state)
.field("transport", &"..")
.finish()
}
}
impl<Transport> From<Conn<Transport>> for Upgrade<Transport> {
fn from(conn: Conn<Transport>) -> Self {
let Conn {
request_headers,
path,
method,
state,
transport,
buffer,
stopper,
..
} = conn;
Self {
request_headers,
path,
method,
state,
transport,
buffer: if buffer.is_empty() {
None
} else {
Some(buffer.into())
},
stopper,
}
}
}
impl<Transport: AsyncRead + Unpin> AsyncRead for Upgrade<Transport> {
fn poll_read(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8],
) -> Poll<io::Result<usize>> {
match self.buffer.take() {
Some(mut buffer) if !buffer.is_empty() => {
let len = buffer.len();
if len > buf.len() {
log::trace!(
"have {} bytes of pending data but can only use {}",
len,
buf.len()
);
let remaining = buffer.split_off(buf.len());
buf.copy_from_slice(&buffer[..]);
self.buffer = Some(remaining);
Poll::Ready(Ok(buf.len()))
} else {
log::trace!("have {} bytes of pending data, using all of it", len);
buf[..len].copy_from_slice(&buffer);
self.buffer = None;
match Pin::new(&mut self.transport).poll_read(cx, &mut buf[len..]) {
Poll::Ready(Ok(e)) => Poll::Ready(Ok(e + len)),
Poll::Pending => Poll::Ready(Ok(len)),
Poll::Ready(Err(e)) => Poll::Ready(Err(e)),
}
}
}
_ => Pin::new(&mut self.transport).poll_read(cx, buf),
}
}
}