# Struct bytes::buf::Limit

source ·

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

Expand description

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

## Implementations§

source §

### impl<T> Limit<T>

source

#### pub fn into_inner(self) -> T

Consumes this `Limit`, returning the underlying value.

source

#### pub fn get_ref(&self) -> &T

Gets a reference to the underlying `BufMut`.

It is inadvisable to directly write to the underlying `BufMut`.

source

#### 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`.

source

#### 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.

source

#### 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§

source §

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

source §

#### 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. Read more
source §

#### 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). Read more
source §

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

Advance the internal cursor of the BufMut Read more
source §

#### fn has_remaining_mut(&self) -> bool

Returns true if there is space in `self` for more bytes. Read more
source §

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

Transfer bytes into `self` from `src` and advance the cursor by the number of bytes written. Read more
source §

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

Transfer bytes into `self` from `src` and advance the cursor by the number of bytes written. Read more
source §

#### fn put_bytes(&mut self, val: u8, cnt: usize)

Put `cnt` bytes `val` into `self`. Read more
source §

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

Writes an unsigned 8 bit integer to `self`. Read more
source §

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

Writes a signed 8 bit integer to `self`. Read more
source §

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

Writes an unsigned 16 bit integer to `self` in big-endian byte order. Read more
source §

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

Writes an unsigned 16 bit integer to `self` in little-endian byte order. Read more
source §

#### fn put_u16_ne(&mut self, n: u16)

Writes an unsigned 16 bit integer to `self` in native-endian byte order. Read more
source §

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

Writes a signed 16 bit integer to `self` in big-endian byte order. Read more
source §

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

Writes a signed 16 bit integer to `self` in little-endian byte order. Read more
source §

#### fn put_i16_ne(&mut self, n: i16)

Writes a signed 16 bit integer to `self` in native-endian byte order. Read more
source §

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

Writes an unsigned 32 bit integer to `self` in big-endian byte order. Read more
source §

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

Writes an unsigned 32 bit integer to `self` in little-endian byte order. Read more
source §

#### fn put_u32_ne(&mut self, n: u32)

Writes an unsigned 32 bit integer to `self` in native-endian byte order. Read more
source §

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

Writes a signed 32 bit integer to `self` in big-endian byte order. Read more
source §

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

Writes a signed 32 bit integer to `self` in little-endian byte order. Read more
source §

#### fn put_i32_ne(&mut self, n: i32)

Writes a signed 32 bit integer to `self` in native-endian byte order. Read more
source §

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

Writes an unsigned 64 bit integer to `self` in the big-endian byte order. Read more
source §

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

Writes an unsigned 64 bit integer to `self` in little-endian byte order. Read more
source §

#### fn put_u64_ne(&mut self, n: u64)

Writes an unsigned 64 bit integer to `self` in native-endian byte order. Read more
source §

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

Writes a signed 64 bit integer to `self` in the big-endian byte order. Read more
source §

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

Writes a signed 64 bit integer to `self` in little-endian byte order. Read more
source §

#### fn put_i64_ne(&mut self, n: i64)

Writes a signed 64 bit integer to `self` in native-endian byte order. Read more
source §

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

Writes an unsigned 128 bit integer to `self` in the big-endian byte order. Read more
source §

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

Writes an unsigned 128 bit integer to `self` in little-endian byte order. Read more
source §

#### fn put_u128_ne(&mut self, n: u128)

Writes an unsigned 128 bit integer to `self` in native-endian byte order. Read more
source §

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

Writes a signed 128 bit integer to `self` in the big-endian byte order. Read more
source §

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

Writes a signed 128 bit integer to `self` in little-endian byte order. Read more
source §

#### fn put_i128_ne(&mut self, n: i128)

Writes a signed 128 bit integer to `self` in native-endian byte order. Read more
source §

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

Writes an unsigned n-byte integer to `self` in big-endian byte order. Read more
source §

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

Writes an unsigned n-byte integer to `self` in the little-endian byte order. Read more
source §

#### fn put_uint_ne(&mut self, n: u64, nbytes: usize)

Writes an unsigned n-byte integer to `self` in the native-endian byte order. Read more
source §

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

Writes low `nbytes` of a signed integer to `self` in big-endian byte order. Read more
source §

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

Writes low `nbytes` of a signed integer to `self` in little-endian byte order. Read more
source §

#### fn put_int_ne(&mut self, n: i64, nbytes: usize)

Writes low `nbytes` of a signed integer to `self` in native-endian byte order. Read more
source §

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

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

#### 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. Read more
source §

#### fn put_f32_ne(&mut self, n: f32)

Writes an IEEE754 single-precision (4 bytes) floating point number to `self` in native-endian byte order. Read more
source §

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

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

#### 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. Read more
source §

#### fn put_f64_ne(&mut self, n: f64)

Writes an IEEE754 double-precision (8 bytes) floating point number to `self` in native-endian byte order. Read more
source §

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

Creates an adaptor which can write at most `limit` bytes to `self`. Read more
source §

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

Available on crate feature `std` only.
Creates an adaptor which implements the `Write` trait for `self`. Read more
source §

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

Creates an adapter which will chain this buffer with another. Read more
source §

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

source §

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl<T> Freeze for Limit<T>
where T: Freeze,

§

### impl<T> RefUnwindSafe for Limit<T>
where T: RefUnwindSafe,

§

### impl<T> Send for Limit<T>
where T: Send,

§

### impl<T> Sync for Limit<T>
where T: Sync,

§

### impl<T> Unpin for Limit<T>
where T: Unpin,

§

### impl<T> UnwindSafe for Limit<T>
where T: UnwindSafe,

## 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.

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, 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.