Struct async_speed_limit::limiter::Resource

pub struct Resource<R, C: Clock> { /* fields omitted */ }

A speed-limited wrapper of a byte stream.

The Resource can be used to limit speed of

• AsyncRead
• AsyncWrite

Just like Limiter, the delay is inserted after the data are sent or received, in which we know the exact amount of bytes transferred to give an accurate delay. The instantaneous speed can exceed the limit if many read/write tasks are started simultaneously. Therefore, restricting the concurrency is also important to avoid breaching the constraint.

Implementations

impl<R, C: Clock> Resource<R, C>

pub fn new(limiter: Limiter<C>, resource: R) -> Self

Creates a new speed-limited resource.

To make the resouce have unlimited speed, set the speed of Limiter to infinity.

pub fn into_inner(self) -> R

Unwraps this value, returns the underlying resource.

pub fn get_ref(&self) -> &R

Gets a reference to the underlying resource.

It is inadvisable to directly operate the underlying resource.

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

Gets a mutable reference to the underlying resource.

It is inadvisable to directly operate the underlying resource.

pub fn get_pin_ref(self: Pin<&Self>) -> Pin<&R>

Gets a pinned reference to the underlying resource.

It is inadvisable to directly operate the underlying resource.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut R>

Gets a pinned mutable reference to the underlying resource.

It is inadvisable to directly operate the underlying resource.

Trait Implementations

impl<R: AsyncRead, C: Clock> AsyncRead for Resource<R, C>

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<R: AsyncWrite, C: Clock> AsyncWrite for Resource<R, C>

fn poll_write(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>

Attempt to write bytes from bufs into the object using vectored IO operations.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

impl<'__pin, R, C: Clock> Unpin for Resource<R, C> where
    __Origin<'__pin, R, C>: Unpin,