Struct leptos_axum::ResponseOptions

pub struct ResponseOptions(pub Arc<RwLock<ResponseParts>>);

Allows you to override details of the HTTP response like the status code and add Headers/Cookies.

ResponseOptions is provided via context when you use most of the handlers provided in this crate, including .leptos_routes, .leptos_routes_with_context, handle_server_fns, etc. You can find the full set of provided context types in each handler function.

If you provide your own handler, you will need to provide ResponseOptions via context yourself if you want to access it via context.

#[server]
pub async fn get_opts() -> Result<(), ServerFnError> {
    let opts = expect_context::<leptos_axum::ResponseOptions>();
    Ok(())
}

Tuple Fields

0: Arc<RwLock<ResponseParts>>

Implementations

impl ResponseOptions

pub fn overwrite(&self, parts: ResponseParts)

A simpler way to overwrite the contents of ResponseOptions with a new ResponseParts.

pub fn set_status(&self, status: StatusCode)

Set the status of the returned Response.

pub fn insert_header(&self, key: HeaderName, value: HeaderValue)

Insert a header, overwriting any previous value with the same key.

pub fn append_header(&self, key: HeaderName, value: HeaderValue)

Append a header, leaving any header with the same key intact.

Trait Implementations

impl Clone for ResponseOptions

fn clone(&self) -> ResponseOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResponseOptions

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

Formats the value using the given formatter.

impl Default for ResponseOptions

fn default() -> ResponseOptions

Returns the “default value” for a type.