Struct zstd_safe::OutBuffer[−][src]

pub struct OutBuffer<'a, C: WriteBuf + ?Sized> {
    pub dst: &'a mut C,
    // some fields omitted
}
Expand description

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()

Fields

dst: &'a mut C

Implementations

impl<'a, C: WriteBuf + ?Sized> OutBuffer<'a, C>[src]

pub fn around(dst: &'a mut C) -> Self[src]

Returns a new OutBuffer around the given slice.

Starts with pos = 0.

pub fn around_pos(dst: &'a mut C, pos: usize) -> Self[src]

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

Panics

If pos >= dst.capacity().

pub fn pos(&self) -> usize[src]

Returns the current cursor position.

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

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, [src]

Returns the part of this buffer that was written to.

Trait Implementations

impl<'a, C: Debug + WriteBuf + ?Sized> Debug for OutBuffer<'a, C>[src]

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<'a, C: ?Sized> Send for OutBuffer<'a, C> where
    C: Send, 

impl<'a, C: ?Sized> Sync for OutBuffer<'a, C> where
    C: Sync, 

impl<'a, C: ?Sized> Unpin for OutBuffer<'a, C>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.