Skip to main content

Response

Struct Response 

Source
pub struct Response { /* private fields */ }
Expand description

Express-style HTTP response.

Implementations§

Source§

impl Response

Source

pub fn empty() -> Self

Source

pub fn text(body: impl Into<String>) -> Self

Source

pub fn html(body: impl Into<String>) -> Self

Source

pub fn json<T: Serialize>(value: &T) -> Self

Source

pub fn redirect(location: impl AsRef<str>) -> Self

Source

pub fn bytes(data: impl Into<Bytes>, mime: &str) -> Self

Buffered body with an explicit MIME type.

Source

pub fn attachment(self, filename: &str) -> Self

Set Content-Disposition: attachment for downloads.

Source

pub fn sse<S, E>(stream: S) -> Self
where S: Stream<Item = Result<String, E>> + Send + Sync + 'static, E: Into<BoxError> + Send + 'static,

Server-Sent Events stream (text/event-stream).

Each item becomes one data: event (multi-line values split across data: lines).

Source

pub fn stream(body: ResponseBody) -> Self

Source

pub fn from_reader_stream<S>(stream: S) -> Self
where S: Stream<Item = Result<Bytes, Error>> + Send + Sync + 'static,

Source

pub fn status(self, code: u16) -> Self

Chainable status: Response::json(&x).status(201).

Source

pub fn header(self, name: impl AsRef<str>, value: impl AsRef<str>) -> Self

Source

pub fn status_code(&self) -> StatusCode

Source

pub fn headers(&self) -> &HeaderMap

Source

pub fn headers_mut(&mut self) -> &mut HeaderMap

Source

pub fn take_body(&mut self) -> Body

Source

pub fn set_body(&mut self, body: impl Into<Body>)

Source

pub fn body_bytes(&self) -> Option<&[u8]>

Body bytes when the response is buffered; None for streams.

Source

pub async fn file(path: impl AsRef<Path>) -> Self

Stream a local file (path-traversal safe relative to its parent directory).

Source

pub async fn file_in(dir: impl AsRef<Path>, relative: impl AsRef<Path>) -> Self

Stream a file under dir / relative (path-traversal safe).

Source

pub async fn download(path: impl AsRef<Path>) -> Self

Self::file plus Content-Disposition: attachment.

Source

pub async fn download_in( dir: impl AsRef<Path>, relative: impl AsRef<Path>, ) -> Self

Self::file_in plus Content-Disposition: attachment.

Trait Implementations§

Source§

impl Debug for Response

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Response

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl IntoResponse for Response

Auto Trait Implementations§

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