Struct DataDump

pub struct DataDump(/* private fields */);

A handle to the Data Dump thread that handles all writes to a location.

This struct implements the blocking Write interface as provided by Rust, instead of the non-blocking AsyncWrite offered by tokio. However, writes are guaranteed to be non-blocking and thus safe to use in async code.

Note

A default DataDump does not write to any location. It is equivalent to sink().

Implementations

impl DataDump

pub async fn new_file(path: impl AsRef<Path>) -> Result<Self>

Create a DataDump that writes to the given path.

For logging purposes, the filename is used as the name of the dump.

Note

If the given path is relative, it will be considered relative to the sub-logging directory. If a logging implementation has not been initialized through init_logger, async_run_all, or run_all, then this method will return a NotFound io error.

pub async fn new_tcp(addr: SocketAddr) -> Result<Self>

Create a DataDump that writes to the network address.

For logging purposes, the address is used as the name of the dump.

pub fn new<A>(writer: A, name: impl Into<String>) -> Result<Self>

where A: AsyncWrite + Unpin + Send + 'static,

Create a DataDump that writes to the given writer.

For logging purposes, the given name is used as the name of the dump.

Trait Implementations

impl Default for DataDump

fn default() -> DataDump

Returns the “default value” for a type.

impl Write for DataDump

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.