Struct StreamWrapper

pub struct StreamWrapper<RW: Unpin> { /* private fields */ }

The wrapper for stream types.

Implementations

impl<RW: Unpin> StreamWrapper<RW>

pub fn new(stream: RW) -> Self

Constructs a wrapped stream.

pub fn make_weak_pin<'a>(self: &'a Arc<Self>) -> Pin<&'a mut Self>

Makes this stream into pinned weak pointer.

Currently upper APIs use this wrapper via Arc. Because avoids problems which every RTMP’s connection steps need same stream but can’t borrow mutablly across scopes. Therefore upper APIs wrap streams into Arc at first, then make them able to copy as weak pointers.

Examples

use std::sync::Arc;
use sheave_core::handlers::{
    StreamWrapper,
    VecStream
};

Arc::new(StreamWrapper::new(VecStream::default())).make_weak_pin();

Trait Implementations

impl<R: AsyncRead + Unpin> AsyncRead for StreamWrapper<R>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<IOResult<()>>

Wraps a stream to make it able to measure the amount of bytes.

When bytes read exceeded some bandwidth limit, RTMP peers are required to send the Acknowldgement message to the other peer. But prepared stream like Vec, slice, or TCP streams has no implementation above. Therefore, StreamWrapper measures amounts of bytes read and writes Acknowledgement messages instead.

impl<W: AsyncWrite + Unpin> AsyncWrite for StreamWrapper<W>

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

Attempt to write bytes from buf into the object.

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

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

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<RW: Debug + Unpin> Debug for StreamWrapper<RW>

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

Formats the value using the given formatter.

impl<RW: Unpin> MeasureAcknowledgement for StreamWrapper<RW>

fn begin_measuring(&mut self)

Resets measured count and turns the flag into on, for beginning measurement.

fn finish_measuring(&mut self)

Resets measured count and turns the flag into off, for finishing measurement.

fn add_amount(&mut self, amount: u32)

Adds received chunk size to current one.

fn get_current_amount(&mut self) -> u32

Gets current chunk size.

fn as_acknowledgement(&mut self) -> Acknowledgement

Wraps current chunk size into an Acknowledgement message.