Struct viceroy_lib::logging::LogEndpoint

pub struct LogEndpoint(_);

A logging endpoint, which for Viceroy is just a name.

Implementations

impl LogEndpoint

pub fn new(name: &[u8]) -> LogEndpoint

Allocate a new LogEndpoint with the given name.

pub fn write_entry(&self, msg: &[u8]) -> Result<()>

Write a log entry to this endpoint.

Log entries are prefixed with the endpoint name and terminated with a newline. Any newlines in the message will be escaped to the string r“\n“.

The entry is written atomically to LOG_WRITER.

Trait Implementations

impl Write for LogEndpoint

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

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

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

Flush 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, fmt: Arguments<'_>) -> Result<(), Error>

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

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

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