Struct zstd::stream::raw::OutBuffer

pub struct OutBuffer<'a, C>
where
    C: WriteBuf + ?Sized,
{ /* private fields */ }

Wrapper around an output buffer.

C is usually either [u8] or Vec<u8>.

Bytes will be written starting at dst[pos].

pos will be updated after writing.

Invariant

pos <= dst.capacity()

Implementations

impl<'a, C> OutBuffer<'a, C>

where C: WriteBuf + ?Sized,

pub fn around(dst: &'a mut C) -> OutBuffer<'a, C>

Returns a new OutBuffer around the given slice.

Starts with pos = 0.

pub fn around_pos(dst: &'a mut C, pos: usize) -> OutBuffer<'a, C>

Returns a new OutBuffer around the given slice, starting at the given position.

Panics

If pos > dst.capacity().

pub fn pos(&self) -> usize

Returns the current cursor position.

Guaranteed to be <= self.capacity()

pub fn capacity(&self) -> usize

Returns the capacity of the underlying buffer.

pub unsafe fn set_pos(&mut self, pos: usize)

Sets the new cursor position.

Panics

If pos > self.dst.capacity().

Safety

Data up to pos must have actually been written to.

pub fn as_slice<'b>(&'b self) -> &'a [u8]

where 'b: 'a,

Returns the part of this buffer that was written to.

pub fn as_mut_ptr(&mut self) -> *mut u8

Returns a pointer to the start of this buffer.

Trait Implementations

impl<'a, C> Debug for OutBuffer<'a, C>

where C: Debug + WriteBuf + ?Sized,

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

Formats the value using the given formatter.