Struct salvo::prelude::Response

pub struct Response { /* private fields */ }

Represents an HTTP response

Implementations

impl Response

pub fn new() -> Response

Creates a new blank Response.

pub fn with_cookies(cookies: CookieJar) -> Response

Creates a new blank Response.

pub fn headers(&self) -> &HeaderMap<HeaderValue>

Get headers reference.

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

Get mutable headers reference.

pub fn set_headers(&mut self, headers: HeaderMap<HeaderValue>)

Sets headers.

pub fn add_header<N, V>(
    &mut self,
    name: N,
    value: V,
    overwrite: bool
) -> Result<(), Error>where
    N: IntoHeaderName,
    V: TryInto<HeaderValue>,

Modify a header for this response.

When overwrite is set to true, If the header is already present, the value will be replaced. When overwrite is set to false, The new header is always appended to the request, even if the header already exists.

pub fn with_header<N, V>(
    &mut self,
    name: N,
    value: V,
    overwrite: bool
) -> Result<&mut Response, Error>where
    N: IntoHeaderName,
    V: TryInto<HeaderValue>,

Modify a header for this response.

When overwrite is set to true, If the header is already present, the value will be replaced. When overwrite is set to false, The new header is always appended to the request, even if the header already exists.

pub fn version(&self) -> Version

Get version.

pub fn version_mut(&mut self) -> &mut Version

Get mutable version reference.

pub fn body(&self) -> &ResBody

Get body reference.

pub fn body_mut(&mut self) -> &mut ResBody

Get mutable body reference.

pub fn set_body(&mut self, body: ResBody)

Sets body.

pub fn replace_body(&mut self, body: ResBody) -> ResBody

Sets body to a new value and returns old value.

pub fn take_body(&mut self) -> ResBody

Take body from response.

pub fn cookies(&self) -> &CookieJar

Get cookies reference.

pub fn cookies_mut(&mut self) -> &mut CookieJar

Get mutable cookies reference.

pub fn cookie<T>(&self, name: T) -> Option<&Cookie<'static>>where
    T: AsRef<str>,

Helper function for get cookie.

pub fn add_cookie(&mut self, cookie: Cookie<'static>) -> &mut Response

Helper function for add cookie.

pub fn with_cookie(&mut self, cookie: Cookie<'static>) -> &mut Response

Helper function for add cookie.

pub fn remove_cookie(&mut self, name: &str) -> &mut Response

Helper function for remove cookie.

Removes cookie from this CookieJar. If an original cookie with the same name as cookie is present in the jar, a removal cookie will be present in the delta computation.

A “removal” cookie is a cookie that has the same name as the original cookie but has an empty value, a max-age of 0, and an expiration date far in the past. Read more about removal cookies.

pub fn status_code(&self) -> Option<StatusCode>

Get status code.

pub fn set_status_code(&mut self, code: StatusCode)

Sets status code.

pub fn with_status_code(&mut self, code: StatusCode) -> &mut Response

Sets status code.

pub fn content_type(&self) -> Option<Mime>

Get content type.

pub fn status_error(&self) -> Option<&StatusError>

Get http error if exists, only exists after use set_status_error set http error.

pub fn set_status_error(&mut self, err: StatusError)

Sets http error.

pub fn with_status_error(&mut self, err: StatusError) -> &mut Response

Sets http error.

pub fn render<P>(&mut self, piece: P)where
    P: Piece,

Render content.

pub fn with_render<P>(&mut self, piece: P) -> &mut Responsewhere
    P: Piece,

Render content.

pub fn stuff<P>(&mut self, code: StatusCode, piece: P)where
    P: Piece,

Render content with status code.

pub fn with_stuff<P>(&mut self, code: StatusCode, piece: P) -> &mut Responsewhere
    P: Piece,

Render content with status code.

pub fn write_body(&mut self, data: impl Into<Bytes>) -> Result<(), Error>

Write bytes data to body. If body is none, a new ResBody will created.

pub fn streaming<S, O, E>(&mut self, stream: S) -> Result<(), Error>where
    S: 'static + Stream<Item = Result<O, E>> + Send,
    O: 'static + Into<Bytes>,
    E: 'static + Into<Box<dyn Error + Send + Sync + 'static, Global>>,

Write streaming data.

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl Display for Response

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

Formats the value using the given formatter.

impl From<Response<Body>> for Response

fn from(res: Response<Body>) -> Response

Converts to this type from the input type.

impl ResponseExt for Response

fn take_string<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    Response: 'async_trait,

Take body as String from response.

fn take_json<'life0, 'async_trait, T>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    T: 'async_trait + DeserializeOwned,
    Response: 'async_trait,

Take body as deserialize it to type T instance.

fn take_string_with_charset<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 mut self,
    charset: &'life1 str,
    compress: Option<&'life2 str>
) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Response: 'async_trait,

Take body as String from response with charset.

fn take_bytes<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Bytes, Error>> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    Response: 'async_trait,

Take all body bytes. If body is none, it will creates and returns a new [Bytes].