Struct Pending 

pub struct Pending { /* private fields */ }

Available on crate features test-util only.

A Read and Write that never completes any reads or writes.

Intended for simple tests and examples that need a never-completing stream.

Implementations

impl Pending

pub fn builder() -> PendingBuilder

Starts building a new PendingStream.

pub fn new() -> Self

Creates a new PendingStream with the default configuration.

pub async fn read_at_most_into( &mut self, _len: usize, _into: BytesBuf, ) -> Result<(usize, BytesBuf), Infallible>

Starts a read operation that never completes.

Errors

This call never fails (because it never completes).

pub async fn read_more_into( &mut self, _into: BytesBuf, ) -> Result<(usize, BytesBuf), Infallible>

Starts a read operation that never completes.

Errors

This call never fails (because it never completes).

pub async fn read_any(&mut self) -> Result<BytesBuf, Infallible>

Starts a read operation that never completes.

Errors

This call never fails (because it never completes).

pub async fn write(&mut self, _sequence: BytesView) -> Result<(), Infallible>

Starts a write operation that never completes.

Errors

This call never fails (because it never completes).

pub fn memory(&self) -> impl MemoryShared

Returns the memory provider that was configured in the builder.

pub fn reserve(&self, min_bytes: usize) -> BytesBuf

Reserves at least min_bytes bytes of memory capacity.

Returns an empty BytesBuf that can be used to fill the reserved memory with data.

The memory provider may provide more memory than requested.

The memory reservation request will always be fulfilled, obtaining more memory from the operating system if necessary.

Zero-sized reservations

Reserving zero bytes of memory is a valid operation and will return a BytesBuf with zero or more bytes of capacity.

Panics

May panic if the operating system runs out of memory.

Trait Implementations

impl Debug for Pending

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

Formats the value using the given formatter.

impl Default for Pending

fn default() -> Self

Returns the “default value” for a type.

impl HasMemory for Pending

fn memory(&self) -> impl MemoryShared

Returns a sharing-compatible memory provider.

impl Memory for Pending

fn reserve(&self, min_bytes: usize) -> BytesBuf

Reserves at least min_bytes bytes of memory capacity.

impl Read for Pending

type Error = Infallible

Type used to signal errors by the implementation of this trait.

async fn read_at_most_into( &mut self, len: usize, into: BytesBuf, ) -> Result<(usize, BytesBuf), Infallible>

Reads at most len bytes into the provided buffer.

async fn read_more_into( &mut self, into: BytesBuf, ) -> Result<(usize, BytesBuf), Infallible>

Reads an unspecified number of bytes into the provided buffer.

async fn read_any(&mut self) -> Result<BytesBuf, Infallible>

Reads an unspecified number of bytes as a new buffer.

impl Write for Pending

type Error = Infallible

Type used to signal errors by the implementation of this trait.

async fn write(&mut self, data: BytesView) -> Result<(), Infallible>

Writes the provided byte sequence.