Struct unit_rs::UnitResponse

pub struct UnitResponse<'a> { /* private fields */ }

An object used to send follow-up response bytes to a request, obtained by calling a UnitRequest’s create_response() method. Dropping this object will end the response.

Implementations

impl UnitResponse<'_>

pub fn send_buffer<T>(
    &mut self,
    size: usize,
    f: impl Fn(&UnitRequest<'_>, &mut &mut [u8]) -> UnitResult<T>
) -> UnitResult<T>

Send another chunk of bytes for this request’s response. The bytes will be immediately sent to the client.

This method allocates a buffer in Unit’s shared memory region, and calls a user function to fill it.

The user function receives a &mut &mut [u8] slice, and the write! macro can be used to advance the start position of the slice. Only the bytes between the original start and the new start positions will be sent, and the rest will be discarded.

Methods from Deref<Target = UnitRequest<'a>>

pub fn read_body(&self, target: &mut [u8]) -> usize

Copy bytes from the request body into the target buffer and return the number of bytes written.

If the buffer is smaller than the contents of the body, the contents will be truncated to the size of the buffer.

pub fn fields(&self) -> impl Iterator<Item = (&str, &str)>

Create an interator over all header (name, value) tuples.

pub fn method(&self) -> &str

Return the method of the request (e.g. “GET”).

pub fn version(&self) -> &str

Return the protocol version of the request (e.g. “HTTP/1.1”).

pub fn remote(&self) -> &str

Return the remote IP address of the client.

pub fn local(&self) -> &str

Return the local IP address of the server.

pub fn server_name(&self) -> &str

Return the host name of the server.

pub fn target(&self) -> &str

Return the combined URI path and query string.

pub fn path(&self) -> &str

Return the URI path.

pub fn query(&self) -> &str

Return the URI query string.

Trait Implementations

impl<'a> Deref for UnitResponse<'a>

type Target = UnitRequest<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.