Skip to main content

Buffer

Struct Buffer 

Source
pub struct Buffer {
    inner: BytesMut,
}
Expand description

Mutable, growable byte container. Used by codecs to build and consume framed payloads, and as an owned container for transport-level payloads.

Fields§

§inner: BytesMut

Implementations§

Source§

impl Buffer

Source

pub fn new() -> Self

Constructs a new, empty Buffer.

Source

pub fn from_slice(data: &[u8]) -> Self

Build a Buffer from a slice (copies).

Source

pub fn len(&self) -> usize

Number of bytes in the buffer.

Source

pub fn resize(&mut self, new_size: usize)

Resize the buffer in-place to new_size (filling with zeros if growing).

Source

pub fn extend_from_slice(&mut self, bytes: &[u8])

Append a slice.

Source

pub fn extend(&mut self, other: &Buffer)

Append bytes from another Buffer.

Source

pub fn advance(&mut self, cnt: usize)

Drop the first cnt bytes, keeping the rest.

Source

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

Source

pub fn freeze(self) -> Bytes

Freeze into an immutable Bytes. Zero-copy — transfers ownership of the underlying allocation.

Trait Implementations§

Source§

impl AsMut<[u8]> for Buffer

Source§

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

Converts this type into a mutable reference of the (usually inferred) input type.
Source§

impl AsRef<[u8]> for Buffer

Source§

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

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Codec<Buffer> for BytesCodec

Source§

type Message = Vec<u8>

Source§

type Error = Error

Source§

fn encode(&self, src: &Vec<u8>, dst: &mut ByteBuffer) -> Result<usize>

Encode a message into the wire buffer.
Source§

fn decode(&self, src: &mut ByteBuffer) -> Result<Option<(usize, Vec<u8>)>>

Decode a message from the wire buffer. Returns Some((bytes_consumed, message)) on success, None if more data is needed.
Source§

impl Codec<Buffer> for LengthCodec

Source§

type Message = Vec<u8>

Source§

type Error = Error

Source§

fn encode(&self, src: &Vec<u8>, dst: &mut ByteBuffer) -> Result<usize>

Encode a message into the wire buffer.
Source§

fn decode(&self, src: &mut ByteBuffer) -> Result<Option<(usize, Vec<u8>)>>

Decode a message from the wire buffer. Returns Some((bytes_consumed, message)) on success, None if more data is needed.
Source§

impl Debug for Buffer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Buffer

Source§

fn default() -> Buffer

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more