Response

Struct Response 

Source
pub struct Response<'a> { /* private fields */ }
Expand description

HTTP response writer passed to a route handler.

Borrows the underlying C response for the duration of the handler call. Do not store this value beyond the handler invocation.

Implementations§

Source§

impl<'a> Response<'a>

Source

pub unsafe fn from_raw(raw: *mut ove_httpd_resp_t) -> Self

Create a Response from a raw C pointer.

§Safety

raw must be a valid pointer obtained from an active httpd handler callback and must remain valid for the lifetime 'a.

Source

pub fn json(&self, status: i32, json: &[u8]) -> Result<()>

Send a JSON response.

json must be a null-terminated byte string.

§Errors

Returns an error if the response cannot be sent.

Source

pub fn html(&self, status: i32, html: &[u8]) -> Result<()>

Send an HTML response.

§Errors

Returns an error if the response cannot be sent.

Source

pub fn send(&self, status: i32, content_type: &[u8], body: &[u8]) -> Result<()>

Send a response with arbitrary content type.

content_type must be a null-terminated byte string.

§Errors

Returns an error if the response cannot be sent.

Source

pub fn error(&self, status: i32, msg: &[u8]) -> Result<()>

Send a JSON error response.

msg must be a null-terminated byte string.

§Errors

Returns an error if the response cannot be sent.

Source

pub fn send_gz( &self, status: i32, content_type: &[u8], body: &[u8], ) -> Result<()>

Send a pre-gzipped response (adds Content-Encoding: gzip).

content_type must be a null-terminated byte string.

§Errors

Returns an error if the response cannot be sent.

Trait Implementations§

Source§

impl Debug for Response<'_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Response<'a>

§

impl<'a> RefUnwindSafe for Response<'a>

§

impl<'a> !Send for Response<'a>

§

impl<'a> !Sync for Response<'a>

§

impl<'a> Unpin for Response<'a>

§

impl<'a> UnwindSafe for Response<'a>

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, 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.