Struct DelayWriter 

pub struct DelayWriter<W: Write> { /* private fields */ }

Wraps a writer and delays its output after each newline.

DelayWriter<W> can be used to display text with multiple lines with a smooth animation. Waits for a Duration after each newline (\n) in the input buffer.

Examples

use std::{time::Duration, io::Write};
use delay_writer::DelayWriter;

let stdout = std::io::stdout();
let mut writer = DelayWriter::new(stdout, Duration::from_millis(100));

let text = "Hello\nWorld!";

writer.write_all(text.as_bytes()).unwrap();

Implementations

impl<W: Write> DelayWriter<W>

pub const fn new(writer: W, delay: Duration) -> Self

Creates a new DelayWriter<W> with a specified delay.

Trait Implementations

impl<W: Write + Debug> Debug for DelayWriter<W>

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

Formats the value using the given formatter.

impl<W: Write + Seek> Seek for DelayWriter<W>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl<W: Write> Write for DelayWriter<W>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.