[][src]Struct bytes::buf::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, BufMut};
use std::io::Cursor;

let mut buf = Cursor::new(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, BufMut};
use std::io::Cursor;

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

assert_eq!(0, buf.get_ref().position());

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};
use std::io::Cursor;

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

buf.get_mut().set_position(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;
use std::io::Cursor;

let mut buf = Cursor::new(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};
use std::io::Cursor;

let mut buf = Cursor::new(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 bytes_vec<'a>(&'a self, dst: &mut [&'a IoVec]) -> 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_be(&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_be(&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_be(&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_be(&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_be(&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_be(&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_uint_be(&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_be(&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_be(&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_be(&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 collect<B>(self) -> B where
    Self: Sized,
    B: FromBuf
[src]

Transforms a Buf into a concrete buffer. 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>(self, next: U) -> Chain<Self, U::Buf> where
    U: IntoBuf,
    Self: Sized
[src]

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

fn by_ref(&mut self) -> &mut Self where
    Self: Sized
[src]

Creates a "by reference" adaptor for this instance of Buf. Read more

Important traits for Reader<B>
fn reader(self) -> Reader<Self> where
    Self: Sized
[src]

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

Important traits for Iter<T>
fn iter(self) -> Iter<Self> where
    Self: Sized
[src]

Returns an iterator over the bytes contained by the buffer. Read more

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

Auto Trait Implementations

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

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

Blanket Implementations

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.

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

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

impl<T> Any for T where
    T: 'static + ?Sized
[src]