Struct bytes::buf::Chain

pub struct Chain<T, U> { /* fields omitted */ }

A Chain sequences two buffers.

Chain is an adapter that links two underlying buffers and provides a continous view across both buffers. It is able to sequence either immutable buffers (Buf values) or mutable buffers (BufMut values).

This struct is generally created by calling Buf::chain. Please see that function's documentation for more detail.

Examples

use bytes::{Bytes, Buf, IntoBuf};
use bytes::buf::Chain;

let buf = Bytes::from(&b"hello "[..]).into_buf()
            .chain(Bytes::from(&b"world"[..]));

let full: Bytes = buf.collect();
assert_eq!(full[..], b"hello world"[..]);

Methods

impl<T, U> Chain<T, U>

pub fn new(a: T, b: U) -> Chain<T, U>

Creates a new Chain sequencing the provided values.

Examples

use bytes::BytesMut;
use bytes::buf::Chain;

let buf = Chain::new(
    BytesMut::with_capacity(1024),
    BytesMut::with_capacity(1024));

// Use the chained buffer

pub fn first_ref(&self) -> &T

Gets a reference to the first underlying Buf.

Examples

use bytes::{Bytes, Buf, IntoBuf};

let buf = Bytes::from(&b"hello"[..]).into_buf()
            .chain(Bytes::from(&b"world"[..]));

assert_eq!(buf.first_ref().get_ref()[..], b"hello"[..]);

pub fn first_mut(&mut self) -> &mut T

Gets a mutable reference to the first underlying Buf.

Examples

use bytes::{Bytes, Buf, IntoBuf};

let mut buf = Bytes::from(&b"hello "[..]).into_buf()
                .chain(Bytes::from(&b"world"[..]));

buf.first_mut().set_position(1);

let full: Bytes = buf.collect();
assert_eq!(full[..], b"ello world"[..]);

pub fn last_ref(&self) -> &U

Gets a reference to the last underlying Buf.

Examples

use bytes::{Bytes, Buf, IntoBuf};

let buf = Bytes::from(&b"hello"[..]).into_buf()
            .chain(Bytes::from(&b"world"[..]));

assert_eq!(buf.last_ref().get_ref()[..], b"world"[..]);

pub fn last_mut(&mut self) -> &mut U

Gets a mutable reference to the last underlying Buf.

Examples

use bytes::{Bytes, Buf, IntoBuf};

let mut buf = Bytes::from(&b"hello "[..]).into_buf()
                .chain(Bytes::from(&b"world"[..]));

buf.last_mut().set_position(1);

let full: Bytes = buf.collect();
assert_eq!(full[..], b"hello orld"[..]);

pub fn into_inner(self) -> (T, U)

Consumes this Chain, returning the underlying values.

Examples

use bytes::{Bytes, Buf, IntoBuf};

let buf = Bytes::from(&b"hello"[..]).into_buf()
            .chain(Bytes::from(&b"world"[..]));

let (first, last) = buf.into_inner();
assert_eq!(first.get_ref()[..], b"hello"[..]);
assert_eq!(last.get_ref()[..], b"world"[..]);

Trait Implementations

impl<T, U> Buf for Chain<T, U> where
    T: Buf,
    U: Buf, 

fn remaining(&self) -> usize

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

fn bytes(&self) -> &[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).

fn advance(&mut self, cnt: usize)

Advance the internal cursor of the Buf

fn bytes_vec<'a>(&'a self, dst: &mut [&'a IoVec]) -> usize

Fills dst with potentially multiple slices starting at self's current position.

fn has_remaining(&self) -> bool

Returns true if there are any more bytes to consume

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

Copies bytes from self into dst.

fn get_u8(&mut self) -> u8

Gets an unsigned 8 bit integer from self.

fn get_i8(&mut self) -> i8

Gets a signed 8 bit integer from self.

fn get_u16_be(&mut self) -> u16

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

fn get_u16_le(&mut self) -> u16

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

fn get_i16_be(&mut self) -> i16

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

fn get_i16_le(&mut self) -> i16

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

fn get_u32_be(&mut self) -> u32

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

fn get_u32_le(&mut self) -> u32

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

fn get_i32_be(&mut self) -> i32

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

fn get_i32_le(&mut self) -> i32

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

fn get_u64_be(&mut self) -> u64

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

fn get_u64_le(&mut self) -> u64

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

fn get_i64_be(&mut self) -> i64

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

fn get_i64_le(&mut self) -> i64

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

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

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

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

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

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

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

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

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

fn get_f32_be(&mut self) -> f32

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

fn get_f32_le(&mut self) -> f32

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

fn get_f64_be(&mut self) -> f64

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

fn get_f64_le(&mut self) -> f64

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

fn collect<B>(self) -> B where
    Self: Sized,
    B: FromBuf, 

Transforms a Buf into a concrete buffer.

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

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

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

Creates an adaptor which will chain this buffer with another.

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, 

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

Important traits for Reader<B>

impl<B: Buf + Sized> Read for Reader<B>

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

Creates an adaptor which implements the Read trait for self.

Important traits for Iter<T>

impl<T: Buf> Iterator for Iter<T> type Item = u8;

fn iter(self) -> Iter<Self> where
    Self: Sized, 

Returns an iterator over the bytes contained by the buffer.

impl<T, U> BufMut for Chain<T, U> where
    T: BufMut,
    U: BufMut, 

fn remaining_mut(&self) -> usize

Returns the number of bytes that can be written from the current position until the end of the buffer is reached.

unsafe fn bytes_mut(&mut self) -> &mut [u8]

Returns a mutable slice starting at the current BufMut position and of length between 0 and BufMut::remaining_mut(). Note that this can be shorter than the whole remainder of the buffer (this allows non-continuous implementation).

unsafe fn advance_mut(&mut self, cnt: usize)

Advance the internal cursor of the BufMut

unsafe fn bytes_vec_mut<'a>(&'a mut self, dst: &mut [&'a mut IoVec]) -> usize

Fills dst with potentially multiple mutable slices starting at self's current position.

fn has_remaining_mut(&self) -> bool

Returns true if there is space in self for more bytes.

fn put<T: IntoBuf>(&mut self, src: T) where
    Self: Sized, 

Transfer bytes into self from src and advance the cursor by the number of bytes written.

fn put_slice(&mut self, src: &[u8])

Transfer bytes into self from src and advance the cursor by the number of bytes written.

fn put_u8(&mut self, n: u8)

Writes an unsigned 8 bit integer to self.

fn put_i8(&mut self, n: i8)

Writes a signed 8 bit integer to self.

fn put_u16_be(&mut self, n: u16)

Writes an unsigned 16 bit integer to self in big-endian byte order.

fn put_u16_le(&mut self, n: u16)

Writes an unsigned 16 bit integer to self in little-endian byte order.

fn put_i16_be(&mut self, n: i16)

Writes a signed 16 bit integer to self in big-endian byte order.

fn put_i16_le(&mut self, n: i16)

Writes a signed 16 bit integer to self in little-endian byte order.

fn put_u32_be(&mut self, n: u32)

Writes an unsigned 32 bit integer to self in big-endian byte order.

fn put_u32_le(&mut self, n: u32)

Writes an unsigned 32 bit integer to self in little-endian byte order.

fn put_i32_be(&mut self, n: i32)

Writes a signed 32 bit integer to self in big-endian byte order.

fn put_i32_le(&mut self, n: i32)

Writes a signed 32 bit integer to self in little-endian byte order.

fn put_u64_be(&mut self, n: u64)

Writes an unsigned 64 bit integer to self in the big-endian byte order.

fn put_u64_le(&mut self, n: u64)

Writes an unsigned 64 bit integer to self in little-endian byte order.

fn put_i64_be(&mut self, n: i64)

Writes a signed 64 bit integer to self in the big-endian byte order.

fn put_i64_le(&mut self, n: i64)

Writes a signed 64 bit integer to self in little-endian byte order.

fn put_uint_be(&mut self, n: u64, nbytes: usize)

Writes an unsigned n-byte integer to self in big-endian byte order.

fn put_uint_le(&mut self, n: u64, nbytes: usize)

Writes an unsigned n-byte integer to self in the little-endian byte order.

fn put_int_be(&mut self, n: i64, nbytes: usize)

Writes a signed n-byte integer to self in big-endian byte order.

fn put_int_le(&mut self, n: i64, nbytes: usize)

Writes a signed n-byte integer to self in little-endian byte order.

fn put_f32_be(&mut self, n: f32)

Writes an IEEE754 single-precision (4 bytes) floating point number to self in big-endian byte order.

fn put_f32_le(&mut self, n: f32)

Writes an IEEE754 single-precision (4 bytes) floating point number to self in little-endian byte order.

fn put_f64_be(&mut self, n: f64)

Writes an IEEE754 double-precision (8 bytes) floating point number to self in big-endian byte order.

fn put_f64_le(&mut self, n: f64)

Writes an IEEE754 double-precision (8 bytes) floating point number to self in little-endian byte order.

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, 

Creates a "by reference" adaptor for this instance of BufMut.

Important traits for Writer<B>

impl<B: BufMut + Sized> Write for Writer<B>

fn writer(self) -> Writer<Self> where
    Self: Sized, 

Creates an adaptor which implements the Write trait for self.

impl<T: Debug, U: Debug> Debug for Chain<T, U>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.