Skip to main content

Input

Struct Input 

Source
pub struct Input { /* private fields */ }
Expand description

The connection’s read buffer: a zero-copy view of what was read and not yet consumed.

let mut input = net_io::Input::from_bytes(b"GET / HTTP/1.1\r\n");
assert_eq!(input.bytes(), b"GET / HTTP/1.1\r\n");
input.consume(4);
assert_eq!(input.bytes(), b"/ HTTP/1.1\r\n");

Implementations§

Source§

impl Input

Source

pub fn from_bytes(bytes: &[u8]) -> Input

An input holding bytes, for tests of sessions (allocates).

Source

pub fn bytes(&self) -> &[u8] ⓘ

The unconsumed bytes.

Source

pub fn consume(&mut self, n: usize)

Consumes n bytes (saturating at the length).

Source

pub fn is_full(&self) -> bool

Whether the buffer is full: the session must consume or grow it.

Source

pub fn class(&self) -> SizeClass

The buffer’s size class.

Source

pub fn swap(&mut self, other: &mut Buffer) -> Result<(), SwapError>

Exchanges the read buffer with an empty other of the same class in O(1): other now holds the unconsumed bytes, and the connection reads into the buffer it was given.

§Errors

SwapError::ClassMismatch, SwapError::NotEmpty.

use net_io::{BufferPool, Input};
let mut input = Input::from_bytes(b"body");
let mut pool = BufferPool::standalone(1 << 20);
let mut spare = pool.take(input.class()).unwrap();
input.swap(&mut spare).unwrap();
assert_eq!(spare.as_slice(), b"body");
assert!(input.bytes().is_empty());

Trait Implementations§

Source§

impl Debug for Input

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Input

§

impl RefUnwindSafe for Input

§

impl Send for Input

§

impl Sync for Input

§

impl Unpin for Input

§

impl UnsafeUnpin for Input

§

impl UnwindSafe for Input

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.