Struct BodyWriter

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

A writer that writes to a Unit shared memory response buffer.

This object is created using Request::write_chunks() or Request::send_chunks_with_writer().

A chunk will be immediately sent to the client once the writer’s memory buffer reaches chunk_size, or flush() is called on the writer, and a new shared memory buffer will be allocated.

The writer will also flush when dropped, but any errors that happen during a drop will panic.

Implementations

impl<'a> BodyWriter<'a>

pub fn copy_from_reader<R: Read>(&mut self, r: R) -> Result<()>

Copy from a reader to this writer without using an intermediary buffer.

Normally the Write trait receives an input buffer to copy from, and the ResponseWriter writer will copy from it into Unit’s shared memory.

This method will instead give Unit’s shared memory buffer directly to the Read trait in order to skip copying to a third temporary buffer (such as when using std::io::copy).

Examples found in repository

examples/request_info.rs (line 40)

fn request_handler(req: Request) -> UnitResult<()> {
    // Create and send a response.
    let headers = &[("Content-Type", "text/plain")];
    req.send_response(200, headers, "Hello world!\n")?;

    // NGINX Unit uses "Transfer-Encoding: chunked" by default, and can send
    // additional chunks after the initial response was already sent to the
    // client.
    req.send_chunks_with_writer(4096, |w| {
        write!(w, "Request data:\n")?;
        write!(w, "  Method: {}\n", req.method())?;
        write!(w, "  Protocol: {}\n", req.version())?;
        write!(w, "  Remote addr: {}\n", req.remote())?;
        write!(w, "  Local addr: {}\n", req.local())?;
        write!(w, "  Server name: {}\n", req.server_name())?;
        write!(w, "  Target: {}\n", req.target())?;
        write!(w, "  Path: {}\n", req.path())?;
        write!(w, "  Query: {}\n", req.query())?;
        write!(w, "  Fields:\n")?;
        for (name, value) in req.fields() {
            write!(w, "    {}: {}\n", name, value).unwrap();
        }
        write!(w, "  Body:\n    ").unwrap();

        w.copy_from_reader(req.body())?;

        Ok(())
    })?;

    Ok(())
}

Trait Implementations

impl Drop for BodyWriter<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Write for BodyWriter<'_>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl UnwindSafe for BodyWriter<'_>