Struct WsBuffer

pub struct WsBuffer<'ws, Item, Suffix, Output> { /* private fields */ }

The free region of the workspace that functions as a “resizable” vector, up to the end of the workspace. The buffer must be finalized using finish() to avoid being reclaimed when dropped.

Implementations

impl<Item, Suffix, Output> WsBuffer<'_, Item, Suffix, Output>

pub fn len(&self) -> usize

Get the length of the written data

pub fn is_empty(&self) -> bool

Check if anything has been written to the buffer

pub fn remaining(&self) -> usize

Get the remaining capacity of the buffer

pub fn push(&mut self, item: Item) -> VclResult<()>

pub fn extend_from_slice(&mut self, slice: &[Item]) -> VclResult<()>

impl WsBuffer<'_, u8, u8, VCL_STRING>

pub fn finish(self) -> VCL_STRING

Finish writing to the WsBuffer, returning the allocated VCL_STRING.

impl WsBuffer<'_, u8, vrt_blob, VCL_BLOB>

pub fn finish(self) -> VCL_BLOB

Finish writing to the WsBlobBuffer, returning the allocated VCL_BLOB.

impl<'ws, T> WsBuffer<'ws, T, (), &'ws [T]>

pub fn finish(self) -> &'ws [T]

Finish writing to the WsTempBuffer, returning the allocated &'ws [T].

Trait Implementations

impl<Item, Suffix, Output> AsMut<[Item]> for WsBuffer<'_, Item, Suffix, Output>

fn as_mut(&mut self) -> &mut [Item]

Get the writable buffer as a slice

impl<Item, Suffix, Output> AsRef<[Item]> for WsBuffer<'_, Item, Suffix, Output>

fn as_ref(&self) -> &[Item]

Get the written data as a slice

impl<'ws, Item: Debug, Suffix: Debug, Output: Debug> Debug for WsBuffer<'ws, Item, Suffix, Output>

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

Formats the value using the given formatter.

impl<Item, Suffix, Output> Drop for WsBuffer<'_, Item, Suffix, Output>

fn drop(&mut self)

Ignore all the write commands, reclaiming the workspace memory

impl<Output, Suffix> Write for WsBuffer<'_, u8, Suffix, Output>

fn write(&mut self, data: &[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, args: 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.