# Struct bytes::buf::Take [−] [src]

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

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

### `impl<T> Take<T>` [src]

#### `pub fn into_inner(self) -> T` [src]

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"[..]);

#### `pub fn get_ref(&self) -> &T` [src]

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

#### `pub fn get_mut(&mut self) -> &mut T` [src]

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"[..]);

#### `pub fn limit(&self) -> usize` [src]

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

#### `pub fn set_limit(&mut self, lim: usize)` [src]

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

### `impl<T: Buf> Buf for Take<T>` [src]

#### `fn remaining(&self) -> usize` [src]

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

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

### Notable traits for &'_ [u8]

`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`
` [src]

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

#### `fn advance(&mut self, cnt: usize)` [src]

Advance the internal cursor of the Buf Read more

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

Fills `dst` with potentially multiple slices starting at `self`’s current position. Read more

#### `fn has_remaining(&self) -> bool` [src]

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

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

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

#### `fn get_u8(&mut self) -> u8` [src]

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

#### `fn get_i8(&mut self) -> i8` [src]

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

#### `fn get_u16(&mut self) -> u16` [src]

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

#### `fn get_u16_le(&mut self) -> u16` [src]

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

#### `fn get_i16(&mut self) -> i16` [src]

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

#### `fn get_i16_le(&mut self) -> i16` [src]

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

#### `fn get_u32(&mut self) -> u32` [src]

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

#### `fn get_u32_le(&mut self) -> u32` [src]

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

#### `fn get_i32(&mut self) -> i32` [src]

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

#### `fn get_i32_le(&mut self) -> i32` [src]

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

#### `fn get_u64(&mut self) -> u64` [src]

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

#### `fn get_u64_le(&mut self) -> u64` [src]

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

#### `fn get_i64(&mut self) -> i64` [src]

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

#### `fn get_i64_le(&mut self) -> i64` [src]

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

#### `fn get_u128(&mut self) -> u128` [src]

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

#### `fn get_u128_le(&mut self) -> u128` [src]

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

#### `fn get_i128(&mut self) -> i128` [src]

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

#### `fn get_i128_le(&mut self) -> i128` [src]

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

#### `fn get_uint(&mut self, nbytes: usize) -> u64` [src]

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

#### `fn get_uint_le(&mut self, nbytes: usize) -> u64` [src]

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

#### `fn get_int(&mut self, nbytes: usize) -> i64` [src]

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

#### `fn get_int_le(&mut self, nbytes: usize) -> i64` [src]

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

#### `fn get_f32(&mut self) -> f32` [src]

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

#### `fn get_f32_le(&mut self) -> f32` [src]

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

#### `fn get_f64(&mut self) -> f64` [src]

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

#### `fn get_f64_le(&mut self) -> f64` [src]

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

#### `fn copy_to_bytes(&mut self, len: usize) -> Bytes` [src]

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

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

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

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

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

#### `fn reader(self) -> Reader<Self>ⓘ

### Notable traits for Reader<B>

`impl<B: Buf + Sized> Read for Reader<B>`
where
Self: Sized,` [src]

Creates an adaptor which implements the `Read` trait for `self`. Read more

### `impl<T: Debug> Debug for Take<T>` [src]

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations

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

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