Struct bytes::buf::Limit

pub struct Limit<T> { /* fields omitted */ }

A BufMut adapter which limits the amount of bytes that can be written to an underlying buffer.

Implementations

impl<T> Limit<T>

pub fn into_inner(self) -> T

Consumes this Limit, returning the underlying value.

pub fn get_ref(&self) -> &T

Gets a reference to the underlying BufMut.

It is inadvisable to directly write to the underlying BufMut.

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the underlying BufMut.

It is inadvisable to directly write to the underlying BufMut.

pub fn limit(&self) -> usize

Returns the maximum number of bytes that can be written

Note

If the inner BufMut has fewer bytes than indicated by this method then that is the actual number of available bytes.

pub fn set_limit(&mut self, lim: usize)

Sets the maximum number of bytes that can be written.

Note

If the inner BufMut has fewer bytes than lim then that is the actual number of available bytes.

Trait Implementations

impl<T: BufMut> BufMut for Limit<T>

pub fn remaining_mut(&self) -> usize

Returns the number of bytes that can be written from the current position until the end of the buffer is reached.

pub fn chunk_mut(&mut self) -> &mut UninitSlice

Returns a mutable slice starting at the current BufMut position and of length between 0 and BufMut::remaining_mut(). Note that this can be shorter than the whole remainder of the buffer (this allows non-continuous implementation).

pub unsafe fn advance_mut(&mut self, cnt: usize)

Advance the internal cursor of the BufMut

pub fn has_remaining_mut(&self) -> bool

Returns true if there is space in self for more bytes.

pub fn put<T: Buf>(&mut self, mut src: T) where
    Self: Sized, 

Transfer bytes into self from src and advance the cursor by the number of bytes written.

pub fn put_slice(&mut self, src: &[u8])

Transfer bytes into self from src and advance the cursor by the number of bytes written.

pub fn put_u8(&mut self, n: u8)

Writes an unsigned 8 bit integer to self.

pub fn put_i8(&mut self, n: i8)

Writes a signed 8 bit integer to self.

pub fn put_u16(&mut self, n: u16)

Writes an unsigned 16 bit integer to self in big-endian byte order.

pub fn put_u16_le(&mut self, n: u16)

Writes an unsigned 16 bit integer to self in little-endian byte order.

pub fn put_i16(&mut self, n: i16)

Writes a signed 16 bit integer to self in big-endian byte order.

pub fn put_i16_le(&mut self, n: i16)

Writes a signed 16 bit integer to self in little-endian byte order.

pub fn put_u32(&mut self, n: u32)

Writes an unsigned 32 bit integer to self in big-endian byte order.

pub fn put_u32_le(&mut self, n: u32)

Writes an unsigned 32 bit integer to self in little-endian byte order.

pub fn put_i32(&mut self, n: i32)

Writes a signed 32 bit integer to self in big-endian byte order.

pub fn put_i32_le(&mut self, n: i32)

Writes a signed 32 bit integer to self in little-endian byte order.

pub fn put_u64(&mut self, n: u64)

Writes an unsigned 64 bit integer to self in the big-endian byte order.

pub fn put_u64_le(&mut self, n: u64)

Writes an unsigned 64 bit integer to self in little-endian byte order.

pub fn put_i64(&mut self, n: i64)

Writes a signed 64 bit integer to self in the big-endian byte order.

pub fn put_i64_le(&mut self, n: i64)

Writes a signed 64 bit integer to self in little-endian byte order.

pub fn put_u128(&mut self, n: u128)

Writes an unsigned 128 bit integer to self in the big-endian byte order.

pub fn put_u128_le(&mut self, n: u128)

Writes an unsigned 128 bit integer to self in little-endian byte order.

pub fn put_i128(&mut self, n: i128)

Writes a signed 128 bit integer to self in the big-endian byte order.

pub fn put_i128_le(&mut self, n: i128)

Writes a signed 128 bit integer to self in little-endian byte order.

pub fn put_uint(&mut self, n: u64, nbytes: usize)

Writes an unsigned n-byte integer to self in big-endian byte order.

pub fn put_uint_le(&mut self, n: u64, nbytes: usize)

Writes an unsigned n-byte integer to self in the little-endian byte order.

pub fn put_int(&mut self, n: i64, nbytes: usize)

Writes a signed n-byte integer to self in big-endian byte order.

pub fn put_int_le(&mut self, n: i64, nbytes: usize)

Writes a signed n-byte integer to self in little-endian byte order.

pub fn put_f32(&mut self, n: f32)

Writes an IEEE754 single-precision (4 bytes) floating point number to self in big-endian byte order.

pub fn put_f32_le(&mut self, n: f32)

Writes an IEEE754 single-precision (4 bytes) floating point number to self in little-endian byte order.

pub fn put_f64(&mut self, n: f64)

Writes an IEEE754 double-precision (8 bytes) floating point number to self in big-endian byte order.

pub fn put_f64_le(&mut self, n: f64)

Writes an IEEE754 double-precision (8 bytes) floating point number to self in little-endian byte order.

pub fn limit(self, limit: usize) -> Limit<Self> where
    Self: Sized, 

Creates an adaptor which can write at most limit bytes to self.

pub fn writer(self) -> Writer<Self> where
    Self: Sized, 

Creates an adaptor which implements the Write trait for self.

pub fn chain_mut<U: BufMut>(self, next: U) -> Chain<Self, U> where
    Self: Sized, 

Creates an adapter which will chain this buffer with another.

impl<T: Debug> Debug for Limit<T>

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

Formats the value using the given formatter.