Struct unit_rs::UnitRequest

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

A request received by the Nginx Unit server.

This object can be used to inspect the properties and headers of the request, and send a response back to the client.

Implementations

impl<'a> UnitRequest<'a>

pub fn create_response(
    self,
    headers: &[(impl AsRef<[u8]>, impl AsRef<[u8]>)],
    body: impl AsRef<[u8]>
) -> UnitResult<UnitResponse<'a>>

Send an initial response to the client, and return a UnitResponse object that allows sending additional data chunks to the client.

This method will consume the request object and wrap it in a response object. The returned object will still deref to a reference of a request object, allowing inspection of the request but no longer allowing the initiation of a second response.

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.