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
sourceimpl<T> Take<T>
impl<T> Take<T>
sourcepub fn into_inner(self) -> T
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"[..]);
sourcepub fn get_ref(&self) -> &T
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());
sourcepub fn get_mut(&mut self) -> &mut T
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"[..]);
sourcepub fn limit(&self) -> usize
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());
sourcepub fn set_limit(&mut self, lim: usize)
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
sourceimpl<T: Buf> Buf for Take<T>
impl<T: Buf> Buf for Take<T>
sourcefn remaining(&self) -> usize
fn remaining(&self) -> usize
Returns the number of bytes between the current position and the end of the buffer. Read more
sourcefn chunk(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
fn chunk(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
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
sourcefn copy_to_bytes(&mut self, len: usize) -> Bytes
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
sourcefn chunks_vectored<'a>(&'a self, dst: &mut [IoSlice<'a>]) -> usize
fn chunks_vectored<'a>(&'a self, dst: &mut [IoSlice<'a>]) -> usize
Fills dst
with potentially multiple slices starting at self
’s
current position. Read more
sourcefn has_remaining(&self) -> bool
fn has_remaining(&self) -> bool
Returns true if there are any more bytes to consume Read more
sourcefn get_u16(&mut self) -> u16
fn get_u16(&mut self) -> u16
Gets an unsigned 16 bit integer from self
in big-endian byte order. Read more
sourcefn get_u16_le(&mut self) -> u16
fn get_u16_le(&mut self) -> u16
Gets an unsigned 16 bit integer from self
in little-endian byte order. Read more
sourcefn get_i16(&mut self) -> i16
fn get_i16(&mut self) -> i16
Gets a signed 16 bit integer from self
in big-endian byte order. Read more
sourcefn get_i16_le(&mut self) -> i16
fn get_i16_le(&mut self) -> i16
Gets a signed 16 bit integer from self
in little-endian byte order. Read more
sourcefn get_u32(&mut self) -> u32
fn get_u32(&mut self) -> u32
Gets an unsigned 32 bit integer from self
in the big-endian byte order. Read more
sourcefn get_u32_le(&mut self) -> u32
fn get_u32_le(&mut self) -> u32
Gets an unsigned 32 bit integer from self
in the little-endian byte order. Read more
sourcefn get_i32(&mut self) -> i32
fn get_i32(&mut self) -> i32
Gets a signed 32 bit integer from self
in big-endian byte order. Read more
sourcefn get_i32_le(&mut self) -> i32
fn get_i32_le(&mut self) -> i32
Gets a signed 32 bit integer from self
in little-endian byte order. Read more
sourcefn get_u64(&mut self) -> u64
fn get_u64(&mut self) -> u64
Gets an unsigned 64 bit integer from self
in big-endian byte order. Read more
sourcefn get_u64_le(&mut self) -> u64
fn get_u64_le(&mut self) -> u64
Gets an unsigned 64 bit integer from self
in little-endian byte order. Read more
sourcefn get_i64(&mut self) -> i64
fn get_i64(&mut self) -> i64
Gets a signed 64 bit integer from self
in big-endian byte order. Read more
sourcefn get_i64_le(&mut self) -> i64
fn get_i64_le(&mut self) -> i64
Gets a signed 64 bit integer from self
in little-endian byte order. Read more
sourcefn get_u128(&mut self) -> u128
fn get_u128(&mut self) -> u128
Gets an unsigned 128 bit integer from self
in big-endian byte order. Read more
sourcefn get_u128_le(&mut self) -> u128
fn get_u128_le(&mut self) -> u128
Gets an unsigned 128 bit integer from self
in little-endian byte order. Read more
sourcefn get_i128(&mut self) -> i128
fn get_i128(&mut self) -> i128
Gets a signed 128 bit integer from self
in big-endian byte order. Read more
sourcefn get_i128_le(&mut self) -> i128
fn get_i128_le(&mut self) -> i128
Gets a signed 128 bit integer from self
in little-endian byte order. Read more
sourcefn get_uint(&mut self, nbytes: usize) -> u64
fn get_uint(&mut self, nbytes: usize) -> u64
Gets an unsigned n-byte integer from self
in big-endian byte order. Read more
sourcefn get_uint_le(&mut self, nbytes: usize) -> u64
fn get_uint_le(&mut self, nbytes: usize) -> u64
Gets an unsigned n-byte integer from self
in little-endian byte order. Read more
sourcefn get_int(&mut self, nbytes: usize) -> i64
fn get_int(&mut self, nbytes: usize) -> i64
Gets a signed n-byte integer from self
in big-endian byte order. Read more
sourcefn get_int_le(&mut self, nbytes: usize) -> i64
fn get_int_le(&mut self, nbytes: usize) -> i64
Gets a signed n-byte integer from self
in little-endian byte order. Read more
sourcefn get_f32(&mut self) -> f32
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
sourcefn get_f32_le(&mut self) -> f32
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
sourcefn get_f64(&mut self) -> f64
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
sourcefn get_f64_le(&mut self) -> f64
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
sourcefn take(self, limit: usize) -> Take<Self> where
Self: Sized,
fn take(self, limit: usize) -> Take<Self> where
Self: Sized,
Creates an adaptor which will read at most limit
bytes from self
. 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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more