Struct edjx::stream::WriteStream

pub struct WriteStream { /* private fields */ }

The WriteStream is used to stream data.

Implementations

impl WriteStream

pub fn write_chunk_text(&mut self, text: &str) -> Result<(), StreamError>

Sends the given &str chunk into the stream

pub fn write_chunk_binary(&mut self, bytes: Vec<u8>) -> Result<(), StreamError>

Sends the given Vec<u8> chunk into the steam

pub fn abort(&self) -> Result<(), StreamError>

Aborts sending data and closes the stream.

This method abruptly ends the streaming.

Difference between WriteStream::close() and WriteStream::abort() when HTTP/1.1 is used for streaming:

• WriteStream::close() sends a terminating chunk of size zero to signalize the end of the stream
• WriteStream::abort() stops streaming without sending the terminating chunk

Note that WriteStream::close() is not available after WriteStream::abort() is called.

Trait Implementations

impl BaseStream for WriteStream

fn sd(&self) -> u32

Get the stream descriptor of this stream

fn close(&self) -> Result<(), StreamError>

Cleanly close the stream

impl Debug for WriteStream

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

Formats the value using the given formatter.