Struct ttyrec::Writer

pub struct Writer<W> { /* fields omitted */ }

Writes ttyrec frames to a tokio::io::AsyncWrite instance.

Methods

impl<W: AsyncWrite> Writer<W>

pub fn new(writer: W) -> Self

Creates a new Writer from a tokio::io::AsyncWrite instance.

pub fn frame(&mut self, data: &[u8]) -> Result<(), Error>

Generates a new ttyrec frame with the given data.

Equivalent to calling frame_at and passing std::time::Instant::now() as the time parameter.

pub fn frame_at(&mut self, time: Instant, data: &[u8]) -> Result<(), Error>

Generates a new ttyrec frame with the given data at the given time.

The frame data will be stored on this object until written out by calls to poll_write.

Note that this is not guaranteed to do the correct thing unless the cur_time parameters given in each frame_at call are non-decreasing.

pub fn poll_write(&mut self) -> Poll<(), Error>

Attempt to write serialized ttyrec frames to the underlying writer.

Writes data from the previous calls to frame and frame_at. Returns Ok(Async::Ready(())) if all bytes were written, and Ok(Async::NotReady) otherwise.

pub fn needs_write(&self) -> bool

Returns true if there are still bytes that need to be written.

It is only necessary to call poll_write if this method returns true.