[][src]Struct bytes::buf::ext::Take

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.

Methods

impl<T> Take<T>[src]

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

Consumes this Take, returning the underlying value.

Examples

use bytes::buf::{Buf, BufMut, BufExt};

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, buf::BufExt};

let mut 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, buf::BufExt};

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, buf::BufExt};

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, buf::BufExt};

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]

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

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]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<B> BufExt for B where
    B: Buf + ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

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.

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.