Struct actix_web::dev::PayloadBuffer

pub struct PayloadBuffer<S> { /* fields omitted */ }

Payload buffer

Methods

impl<S> PayloadBuffer<S> where     S: Stream<Item = Bytes, Error = PayloadError>,

pub fn new(stream: S) -> Self

Create new PayloadBuffer instance

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn get_mut(&mut self) -> &mut S

Get mutable reference to an inner stream.

pub fn readany(&mut self) -> Poll<Option<Bytes>, PayloadError>

Read first available chunk of bytes

pub fn can_read(&mut self, size: usize) -> Poll<Option<bool>, PayloadError>

Check if buffer contains enough bytes

pub fn get_chunk(&mut self) -> Poll<Option<&[u8]>, PayloadError>

Return reference to the first chunk of data

pub fn read_exact(&mut self, size: usize) -> Poll<Option<Bytes>, PayloadError>

Read exact number of bytes

pub fn drop_bytes(&mut self, size: usize)

Remove specified amount if bytes from buffer

pub fn copy(&mut self, size: usize) -> Poll<Option<BytesMut>, PayloadError>

Copy buffered data

pub fn read_until(&mut self, line: &[u8]) -> Poll<Option<Bytes>, PayloadError>

Read until specified ending

pub fn readline(&mut self) -> Poll<Option<Bytes>, PayloadError>

Read bytes until new line delimiter

pub fn unprocessed(&mut self, data: Bytes)

Put unprocessed data back to the buffer

pub fn remaining(&mut self) -> Bytes

Get remaining data from the buffer