# Struct bytes::buf::Take

source ·

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

Expand description

A `Buf` adapter which limits the bytes read from an underlying buffer.

This struct is generally created by calling `take()` on `Buf`. See documentation of `take()` for more details.

## Implementations§

source §

### impl<T> Take<T>

source

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

Consumes this `Take`, returning the underlying value.

##### §Examples

    use bytes::{Buf, BufMut};

    let mut buf = b"hello world".take(2);
    let mut dst = vec![];

    dst.put(&mut buf);
    assert_eq!(*dst, b"he"[..]);

    let mut buf = buf.into_inner();

    dst.clear();
    dst.put(&mut buf);
    assert_eq!(*dst, b"llo world"[..]);

source

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

Gets a reference to the underlying `Buf`.

It is inadvisable to directly read from the underlying `Buf`.

##### §Examples

    use bytes::Buf;

    let buf = b"hello world".take(2);

    assert_eq!(11, buf.get_ref().remaining());

source

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

Gets a mutable reference to the underlying `Buf`.

It is inadvisable to directly read from the underlying `Buf`.

##### §Examples

    use bytes::{Buf, BufMut};

    let mut buf = b"hello world".take(2);
    let mut dst = vec![];

    buf.get_mut().advance(2);

    dst.put(&mut buf);
    assert_eq!(*dst, b"ll"[..]);

source

#### pub fn limit(&self) -> usize

Returns the maximum number of bytes that can be read.

##### §Note

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

##### §Examples

    use bytes::Buf;

    let mut buf = b"hello world".take(2);

    assert_eq!(2, buf.limit());
    assert_eq!(b'h', buf.get_u8());
    assert_eq!(1, buf.limit());

source

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

Sets the maximum number of bytes that can be read.

##### §Note

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

##### §Examples

    use bytes::{Buf, BufMut};

    let mut buf = b"hello world".take(2);
    let mut dst = vec![];

    dst.put(&mut buf);
    assert_eq!(*dst, b"he"[..]);

    dst.clear();

    buf.set_limit(3);
    dst.put(&mut buf);
    assert_eq!(*dst, b"llo"[..]);

## Trait Implementations§

source §

### impl<T: Buf> Buf for Take<T>

source §

#### fn remaining(&self) -> usize

Returns the number of bytes between the current position and the end of the buffer. Read more
source §

#### fn chunk(&self) -> &[u8] ⓘ

Returns a slice starting at the current position and of length between 0 and `Buf::remaining()`. Note that this can return a shorter slice (this allows non-continuous internal representation). Read more
source §

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

Advance the internal cursor of the Buf Read more
source §

#### fn copy_to_bytes(&mut self, len: usize) -> Bytes

Consumes `len` bytes inside self and returns new instance of `Bytes` with this data. Read more
source §

#### fn chunks_vectored<'a>(&'a self, dst: &mut [IoSlice<'a>]) -> usize

Available on crate feature `std` only.
Fills `dst` with potentially multiple slices starting at `self`’s current position. Read more
source §

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

Returns true if there are any more bytes to consume Read more
source §

#### fn copy_to_slice(&mut self, dst: &mut [u8])

Copies bytes from `self` into `dst`. Read more
source §

#### fn get_u8(&mut self) -> u8

Gets an unsigned 8 bit integer from `self`. Read more
source §

#### fn get_i8(&mut self) -> i8

Gets a signed 8 bit integer from `self`. Read more
source §

#### fn get_u16(&mut self) -> u16

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

#### fn get_u16_le(&mut self) -> u16

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

#### fn get_u16_ne(&mut self) -> u16

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

#### fn get_i16(&mut self) -> i16

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

#### fn get_i16_le(&mut self) -> i16

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

#### fn get_i16_ne(&mut self) -> i16

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

#### fn get_u32(&mut self) -> u32

Gets an unsigned 32 bit integer from `self` in the big-endian byte order. Read more
source §

#### fn get_u32_le(&mut self) -> u32

Gets an unsigned 32 bit integer from `self` in the little-endian byte order. Read more
source §

#### fn get_u32_ne(&mut self) -> u32

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

#### fn get_i32(&mut self) -> i32

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

#### fn get_i32_le(&mut self) -> i32

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

#### fn get_i32_ne(&mut self) -> i32

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

#### fn get_u64(&mut self) -> u64

Gets an unsigned 64 bit integer from `self` in big-endian byte order. Read more
source §

#### fn get_u64_le(&mut self) -> u64

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

#### fn get_u64_ne(&mut self) -> u64

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

#### fn get_i64(&mut self) -> i64

Gets a signed 64 bit integer from `self` in big-endian byte order. Read more
source §

#### fn get_i64_le(&mut self) -> i64

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

#### fn get_i64_ne(&mut self) -> i64

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

#### fn get_u128(&mut self) -> u128

Gets an unsigned 128 bit integer from `self` in big-endian byte order. Read more
source §

#### fn get_u128_le(&mut self) -> u128

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

#### fn get_u128_ne(&mut self) -> u128

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

#### fn get_i128(&mut self) -> i128

Gets a signed 128 bit integer from `self` in big-endian byte order. Read more
source §

#### fn get_i128_le(&mut self) -> i128

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

#### fn get_i128_ne(&mut self) -> i128

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

#### fn get_uint(&mut self, nbytes: usize) -> u64

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

#### fn get_uint_le(&mut self, nbytes: usize) -> u64

Gets an unsigned n-byte integer from `self` in little-endian byte order. Read more
source §

#### fn get_uint_ne(&mut self, nbytes: usize) -> u64

Gets an unsigned n-byte integer from `self` in native-endian byte order. Read more
source §

#### fn get_int(&mut self, nbytes: usize) -> i64

Gets a signed n-byte integer from `self` in big-endian byte order. Read more
source §

#### fn get_int_le(&mut self, nbytes: usize) -> i64

Gets a signed n-byte integer from `self` in little-endian byte order. Read more
source §

#### fn get_int_ne(&mut self, nbytes: usize) -> i64

Gets a signed n-byte integer from `self` in native-endian byte order. Read more
source §

#### fn get_f32(&mut self) -> f32

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

#### fn get_f32_le(&mut self) -> f32

Gets an IEEE754 single-precision (4 bytes) floating point number from `self` in little-endian byte order. Read more
source §

#### fn get_f32_ne(&mut self) -> f32

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

#### fn get_f64(&mut self) -> f64

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

#### fn get_f64_le(&mut self) -> f64

Gets an IEEE754 double-precision (8 bytes) floating point number from `self` in little-endian byte order. Read more
source §

#### fn get_f64_ne(&mut self) -> f64

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

#### fn try_copy_to_slice(&mut self, dst: &mut [u8]) -> Result<(), TryGetError>

Copies bytes from `self` into `dst`. Read more
source §

#### fn try_get_u8(&mut self) -> Result<u8, TryGetError>

Gets an unsigned 8 bit integer from `self`. Read more
source §

#### fn try_get_i8(&mut self) -> Result<i8, TryGetError>

Gets a signed 8 bit integer from `self`. Read more
source §

#### fn try_get_u16(&mut self) -> Result<u16, TryGetError>

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

#### fn try_get_u16_le(&mut self) -> Result<u16, TryGetError>

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

#### fn try_get_u16_ne(&mut self) -> Result<u16, TryGetError>

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

#### fn try_get_i16(&mut self) -> Result<i16, TryGetError>

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

#### fn try_get_i16_le(&mut self) -> Result<i16, TryGetError>

Gets an signed 16 bit integer from `self` in little-endian byte order. Read more
source §

#### fn try_get_i16_ne(&mut self) -> Result<i16, TryGetError>

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

#### fn try_get_u32(&mut self) -> Result<u32, TryGetError>

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

#### fn try_get_u32_le(&mut self) -> Result<u32, TryGetError>

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

#### fn try_get_u32_ne(&mut self) -> Result<u32, TryGetError>

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

#### fn try_get_i32(&mut self) -> Result<i32, TryGetError>

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

#### fn try_get_i32_le(&mut self) -> Result<i32, TryGetError>

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

#### fn try_get_i32_ne(&mut self) -> Result<i32, TryGetError>

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

#### fn try_get_u64(&mut self) -> Result<u64, TryGetError>

Gets an unsigned 64 bit integer from `self` in big-endian byte order. Read more
source §

#### fn try_get_u64_le(&mut self) -> Result<u64, TryGetError>

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

#### fn try_get_u64_ne(&mut self) -> Result<u64, TryGetError>

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

#### fn try_get_i64(&mut self) -> Result<i64, TryGetError>

Gets a signed 64 bit integer from `self` in big-endian byte order. Read more
source §

#### fn try_get_i64_le(&mut self) -> Result<i64, TryGetError>

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

#### fn try_get_i64_ne(&mut self) -> Result<i64, TryGetError>

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

#### fn try_get_u128(&mut self) -> Result<u128, TryGetError>

Gets an unsigned 128 bit integer from `self` in big-endian byte order. Read more
source §

#### fn try_get_u128_le(&mut self) -> Result<u128, TryGetError>

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

#### fn try_get_u128_ne(&mut self) -> Result<u128, TryGetError>

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

#### fn try_get_i128(&mut self) -> Result<i128, TryGetError>

Gets a signed 128 bit integer from `self` in big-endian byte order. Read more
source §

#### fn try_get_i128_le(&mut self) -> Result<i128, TryGetError>

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

#### fn try_get_i128_ne(&mut self) -> Result<i128, TryGetError>

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

#### fn try_get_uint(&mut self, nbytes: usize) -> Result<u64, TryGetError>

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

#### fn try_get_uint_le(&mut self, nbytes: usize) -> Result<u64, TryGetError>

Gets an unsigned n-byte integer from `self` in little-endian byte order. Read more
source §

#### fn try_get_uint_ne(&mut self, nbytes: usize) -> Result<u64, TryGetError>

Gets an unsigned n-byte integer from `self` in native-endian byte order. Read more
source §

#### fn try_get_int(&mut self, nbytes: usize) -> Result<i64, TryGetError>

Gets a signed n-byte integer from `self` in big-endian byte order. Read more
source §

#### fn try_get_int_le(&mut self, nbytes: usize) -> Result<i64, TryGetError>

Gets a signed n-byte integer from `self` in little-endian byte order. Read more
source §

#### fn try_get_int_ne(&mut self, nbytes: usize) -> Result<i64, TryGetError>

Gets a signed n-byte integer from `self` in native-endian byte order. Read more
source §

#### fn try_get_f32(&mut self) -> Result<f32, TryGetError>

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

#### fn try_get_f32_le(&mut self) -> Result<f32, TryGetError>

Gets an IEEE754 single-precision (4 bytes) floating point number from `self` in little-endian byte order. Read more
source §

#### fn try_get_f32_ne(&mut self) -> Result<f32, TryGetError>

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

#### fn try_get_f64(&mut self) -> Result<f64, TryGetError>

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

#### fn try_get_f64_le(&mut self) -> Result<f64, TryGetError>

Gets an IEEE754 double-precision (8 bytes) floating point number from `self` in little-endian byte order. Read more
source §

#### fn try_get_f64_ne(&mut self) -> Result<f64, TryGetError>

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

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

Creates an adaptor which will read at most `limit` bytes from `self`. Read more
source §

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

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

#### fn reader(self) -> Reader<Self> ⓘ
where Self: Sized,

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

### impl<T: Debug> Debug for Take<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 Take<T>
where T: Freeze,

§

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

§

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

§

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

§

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

§

### impl<T> UnwindSafe for Take<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.