# actix_web::dev::PayloadBuffer - Rust
API documentation for the Rust `PayloadBuffer` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, PayloadBuffer

# [−] [src] 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>,`

[src]

####

`pub fn new(stream: S) -> Self`

[src]

Create new `PayloadBuffer` instance

####

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

[src]

Get mutable reference to an inner stream.

####

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

[src]

Read first available chunk of bytes

####

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

[src]

Check if buffer contains enough bytes

####

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

[src]

Return reference to the first chunk of data

####

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

[src]

Read exact number of bytes

####

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

[src]

Remove specified amount if bytes from buffer

####

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

[src]

Copy buffered data

####

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

[src]

Read until specified ending

####

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

[src]

Read bytes until new line delimiter

####

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

[src]

Put unprocessed data back to the buffer

####

`pub fn remaining(&mut self) -> Bytes`

[src]

Get remaining data from the buffer

## Auto Trait Implementations

###

`impl<S> Send for PayloadBuffer<S> where S: Send,`

###

`impl<S> Sync for PayloadBuffer<S> where S: Sync,`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id`)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T> Erased for T`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)