[−][src]Struct tide::http::Response
An HTTP response.
Examples
use http_types::{Response, StatusCode}; let mut res = Response::new(StatusCode::Ok); res.set_body("Hello, Nori!");
Implementations
impl Response
[src]
pub fn new<S>(status: S) -> Response where
S: TryInto<StatusCode>,
<S as TryInto<StatusCode>>::Error: Debug,
[src]
S: TryInto<StatusCode>,
<S as TryInto<StatusCode>>::Error: Debug,
Create a new response.
pub fn status(&self) -> StatusCode
[src]
Get the status
pub fn header_mut(
&mut self,
name: impl Into<HeaderName>
) -> Option<&mut HeaderValues>
[src]
&mut self,
name: impl Into<HeaderName>
) -> Option<&mut HeaderValues>
Get a mutable reference to a header.
pub fn header(&self, name: impl Into<HeaderName>) -> Option<&HeaderValues>
[src]
Get an HTTP header.
pub fn remove_header(
&mut self,
name: impl Into<HeaderName>
) -> Option<HeaderValues>
[src]
&mut self,
name: impl Into<HeaderName>
) -> Option<HeaderValues>
Remove a header.
pub fn insert_header(
&mut self,
name: impl Into<HeaderName>,
values: impl ToHeaderValues
) -> Option<HeaderValues>
[src]
&mut self,
name: impl Into<HeaderName>,
values: impl ToHeaderValues
) -> Option<HeaderValues>
Set an HTTP header.
Examples
use http_types::{Method, Response, StatusCode, Url}; let mut req = Response::new(StatusCode::Ok); req.insert_header("Content-Type", "text/plain");
pub fn append_header(
&mut self,
name: impl Into<HeaderName>,
values: impl ToHeaderValues
)
[src]
&mut self,
name: impl Into<HeaderName>,
values: impl ToHeaderValues
)
Append a header to the headers.
Unlike insert
this function will not override the contents of a
header, but insert a header if there aren't any. Or else append to
the existing list of headers.
Examples
use http_types::{Response, StatusCode}; let mut res = Response::new(StatusCode::Ok); res.append_header("Content-Type", "text/plain");
pub fn set_body(&mut self, body: impl Into<Body>)
[src]
Set the body reader.
Examples
use http_types::{Response, StatusCode}; let mut res = Response::new(StatusCode::Ok); res.set_body("Hello, Nori!");
pub fn replace_body(&mut self, body: impl Into<Body>) -> Body
[src]
Replace the response body with a new body, returning the old body.
Examples
use http_types::{Body, Method, Response, StatusCode, Url}; let mut req = Response::new(StatusCode::Ok); req.set_body("Hello, Nori!"); let mut body: Body = req.replace_body("Hello, Chashu"); let mut string = String::new(); body.read_to_string(&mut string).await?; assert_eq!(&string, "Hello, Nori!");
pub fn swap_body(&mut self, body: &mut Body)
[src]
Swaps the value of the body with another body, without deinitializing either one.
Examples
use http_types::{Body, Method, Response, StatusCode, Url}; let mut req = Response::new(StatusCode::Ok); req.set_body("Hello, Nori!"); let mut body = "Hello, Chashu!".into(); req.swap_body(&mut body); let mut string = String::new(); body.read_to_string(&mut string).await?; assert_eq!(&string, "Hello, Nori!");
pub fn take_body(&mut self) -> Body
[src]
Take the response body, replacing it with an empty body.
Examples
use http_types::{Body, Method, Response, StatusCode, Url}; let mut req = Response::new(StatusCode::Ok); req.set_body("Hello, Nori!"); let mut body: Body = req.take_body(); let mut string = String::new(); body.read_to_string(&mut string).await?; assert_eq!(&string, "Hello, Nori!");
pub async fn body_string(&'_ mut self) -> Result<String, Error>
[src]
Read the body as a string.
This consumes the response. If you want to read the body without
consuming the response, consider using the take_body
method and
then calling Body::into_string
or using the Response's AsyncRead
implementation to read the body.
Examples
use async_std::io::Cursor; use http_types::{Body, Method, Response, StatusCode, Url}; let mut res = Response::new(StatusCode::Ok); let cursor = Cursor::new("Hello Nori"); let body = Body::from_reader(cursor, None); res.set_body(body); assert_eq!(&res.body_string().await.unwrap(), "Hello Nori");
pub async fn body_bytes(&'_ mut self) -> Result<Vec<u8>, Error>
[src]
Read the body as bytes.
This consumes the Response
. If you want to read the body without
consuming the response, consider using the take_body
method and
then calling Body::into_bytes
or using the Response's AsyncRead
implementation to read the body.
Examples
use http_types::{Body, Method, Response, StatusCode, Url}; let bytes = vec![1, 2, 3]; let mut res = Response::new(StatusCode::Ok); res.set_body(Body::from_bytes(bytes)); let bytes = res.body_bytes().await?; assert_eq!(bytes, vec![1, 2, 3]);
pub async fn body_json<T>(&'_ mut self) -> Result<T, Error> where
T: DeserializeOwned,
[src]
T: DeserializeOwned,
Read the body as JSON.
This consumes the response. If you want to read the body without
consuming the response, consider using the take_body
method and
then calling Body::into_json
or using the Response's AsyncRead
implementation to read the body.
Examples
use http_types::convert::{Deserialize, Serialize}; use http_types::{Body, Method, Response, StatusCode, Url}; #[derive(Debug, Serialize, Deserialize)] struct Cat { name: String, } let cat = Cat { name: String::from("chashu"), }; let mut res = Response::new(StatusCode::Ok); res.set_body(Body::from_json(&cat)?); let cat: Cat = res.body_json().await?; assert_eq!(&cat.name, "chashu");
pub async fn body_form<T>(&'_ mut self) -> Result<T, Error> where
T: DeserializeOwned,
[src]
T: DeserializeOwned,
Read the body as x-www-form-urlencoded
.
This consumes the request. If you want to read the body without
consuming the request, consider using the take_body
method and
then calling Body::into_json
or using the Response's AsyncRead
implementation to read the body.
Examples
use http_types::convert::{Deserialize, Serialize}; use http_types::{Body, Method, Response, StatusCode, Url}; #[derive(Debug, Serialize, Deserialize)] struct Cat { name: String, } let cat = Cat { name: String::from("chashu"), }; let mut res = Response::new(StatusCode::Ok); res.set_body(Body::from_form(&cat)?); let cat: Cat = res.body_form().await?; assert_eq!(&cat.name, "chashu");
pub fn set_content_type(&mut self, mime: Mime) -> Option<HeaderValues>
[src]
Set the response MIME.
pub fn content_type(&self) -> Option<Mime>
[src]
Get the current content type
pub fn len(&self) -> Option<usize>
[src]
Get the length of the body stream, if it has been set.
This value is set when passing a fixed-size object into as the body.
E.g. a string, or a buffer. Consumers of this API should check this
value to decide whether to use Chunked
encoding, or set the
response length.
pub fn is_empty(&self) -> Option<bool>
[src]
Returns true
if the set length of the body stream is zero, false
otherwise.
pub fn version(&self) -> Option<Version>
[src]
Get the HTTP version, if one has been set.
Examples
use http_types::{Response, StatusCode, Version}; let mut res = Response::new(StatusCode::Ok); assert_eq!(res.version(), None); res.set_version(Some(Version::Http2_0)); assert_eq!(res.version(), Some(Version::Http2_0));
pub fn set_peer_addr(&mut self, peer_addr: Option<impl ToString>)
[src]
Sets a string representation of the peer address that this response was sent to. This might take the form of an ip/fqdn and port or a local socket address.
pub fn set_local_addr(&mut self, local_addr: Option<impl ToString>)
[src]
Sets a string representation of the local address that this response was sent on. This might take the form of an ip/fqdn and port, or a local socket address.
pub fn peer_addr(&self) -> Option<&str>
[src]
Get the peer socket address for the underlying transport, if appropriate
pub fn local_addr(&self) -> Option<&str>
[src]
Get the local socket address for the underlying transport, if appropriate
pub fn set_version(&mut self, version: Option<Version>)
[src]
Set the HTTP version.
Examples
use http_types::{Response, StatusCode, Version}; let mut res = Response::new(StatusCode::Ok); res.set_version(Some(Version::Http2_0));
pub fn set_status(&mut self, status: StatusCode)
[src]
Set the status.
pub fn send_trailers(&mut self) -> Sender
[src]
Sends trailers to the a receiver.
pub async fn recv_trailers(&'_ mut self) -> Receiver
[src]
Receive trailers from a sender.
pub fn iter(&self) -> Iter
[src]
An iterator visiting all header pairs in arbitrary order.
pub fn iter_mut(&mut self) -> IterMut
[src]
An iterator visiting all header pairs in arbitrary order, with mutable references to the values.
pub fn header_names(&self) -> Names
[src]
An iterator visiting all header names in arbitrary order.
pub fn header_values(&self) -> Values
[src]
An iterator visiting all header values in arbitrary order.
pub fn ext(&self) -> &Extensions
[src]
Returns a reference to the existing local.
pub fn ext_mut(&mut self) -> &mut Extensions
[src]
Returns a mutuable reference to the existing local state.
Examples
use http_types::{Response, StatusCode, Version}; let mut res = Response::new(StatusCode::Ok); res.ext_mut().insert("hello from the extension"); assert_eq!(res.ext().get(), Some(&"hello from the extension"));
Trait Implementations
impl AsMut<Headers> for Response
[src]
impl AsMut<Response> for Response
[src]
impl AsRef<Headers> for Response
[src]
impl AsRef<Response> for Response
[src]
impl AsyncBufRead for Response
[src]
fn poll_fill_buf(
self: Pin<&mut Response>,
cx: &mut Context
) -> Poll<Result<&[u8], Error>>
[src]
self: Pin<&mut Response>,
cx: &mut Context
) -> Poll<Result<&[u8], Error>>
fn consume(self: Pin<&mut Response>, amt: usize)
[src]
impl AsyncRead for Response
[src]
fn poll_read(
self: Pin<&mut Response>,
cx: &mut Context,
buf: &mut [u8]
) -> Poll<Result<usize, Error>>
[src]
self: Pin<&mut Response>,
cx: &mut Context,
buf: &mut [u8]
) -> Poll<Result<usize, Error>>
fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context,
bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context,
bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>
impl Clone for Response
[src]
fn clone(&self) -> Response
[src]
Clone the response, resolving the body to Body::empty()
and removing
extensions.
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for Response
[src]
impl From<()> for Response
[src]
impl From<Response> for Response
[src]
impl From<StatusCode> for Response
[src]
fn from(s: StatusCode) -> Response
[src]
impl<T> From<T> for Response where
T: Into<Body>,
[src]
T: Into<Body>,
impl<'_> Index<&'_ str> for Response
[src]
type Output = HeaderValues
The returned type after indexing.
fn index(&self, name: &str) -> &HeaderValues
[src]
Returns a reference to the value corresponding to the supplied name.
Panics
Panics if the name is not present in Response
.
impl Index<HeaderName> for Response
[src]
type Output = HeaderValues
The returned type after indexing.
fn index(&self, name: HeaderName) -> &HeaderValues
[src]
Returns a reference to the value corresponding to the supplied name.
Panics
Panics if the name is not present in Response
.
impl Into<Response> for Response
[src]
impl IntoIterator for Response
[src]
type Item = (HeaderName, HeaderValues)
The type of the elements being iterated over.
type IntoIter = IntoIter
Which kind of iterator are we turning this into?
fn into_iter(self) -> <Response as IntoIterator>::IntoIter
[src]
Returns a iterator of references over the remaining items.
impl<'a> IntoIterator for &'a mut Response
[src]
type Item = (&'a HeaderName, &'a mut HeaderValues)
The type of the elements being iterated over.
type IntoIter = IterMut<'a>
Which kind of iterator are we turning this into?
fn into_iter(self) -> <&'a mut Response as IntoIterator>::IntoIter
[src]
impl<'a> IntoIterator for &'a Response
[src]
type Item = (&'a HeaderName, &'a HeaderValues)
The type of the elements being iterated over.
type IntoIter = Iter<'a>
Which kind of iterator are we turning this into?
fn into_iter(self) -> <&'a Response as IntoIterator>::IntoIter
[src]
impl<'__pin> Unpin for Response where
__Origin<'__pin>: Unpin,
[src]
__Origin<'__pin>: Unpin,
Auto Trait Implementations
impl !RefUnwindSafe for Response
impl Send for Response
impl Sync for Response
impl !UnwindSafe for Response
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
[src]
R: AsyncBufRead + ?Sized,
fn read_until(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self> where
Self: Unpin,
[src]
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self> where
Self: Unpin,
fn read_line(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn lines(self) -> Lines<Self>
[src]
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
[src]
R: AsyncRead + ?Sized,
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,
[src]
R: AsyncRead,
fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self> where
Self: Unpin,
[src]
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self> where
Self: Unpin,
fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn read_to_end(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
Self: AsyncWrite,
fn take(self, limit: u64) -> Take<Self>
[src]
fn compat(self) -> Compat<Self> where
Self: Unpin,
[src]
Self: Unpin,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> BufReadExt for T where
T: AsyncBufRead + ?Sized,
[src]
T: AsyncBufRead + ?Sized,
fn read_until(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntilFuture<'a, Self> where
Self: Unpin,
[src]
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntilFuture<'a, Self> where
Self: Unpin,
fn read_line(&'a mut self, buf: &'a mut String) -> ReadLineFuture<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn lines(self) -> Lines<Self> where
Self: Unpin,
[src]
Self: Unpin,
fn split(self, byte: u8) -> Split<Self>
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<I> IntoIterator for I where
I: Iterator,
[src]
I: Iterator,
type Item = <I as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = I
Which kind of iterator are we turning this into?
fn into_iter(self) -> I
[src]
impl<T> ReadExt for T where
T: AsyncRead + ?Sized,
[src]
T: AsyncRead + ?Sized,
fn read(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
Self: Unpin,
[src]
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
Self: Unpin,
fn read_to_end(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEndFuture<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn read_to_string(
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
Self: Unpin,
[src]
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
Self: Unpin,
fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn take(self, limit: u64) -> Take<Self>
[src]
fn by_ref(&mut self) -> &mut Self
[src]
fn bytes(self) -> Bytes<Self>
[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,
[src]
R: AsyncRead,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Sealed<T> for T where
T: ?Sized,
T: ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,