Struct utf8_io::Utf8Writer

pub struct Utf8Writer<Inner: Write> { /* fields omitted */ }

A Write implementation which translates into an output Write producing a valid UTF-8 sequence from an arbitrary byte sequence from an arbitrary byte sequence. Attempts to write invalid encodings are reported as errors.

This type's write is not guaranteed to perform a single underlying write operation, because short writes could produce invalid UTF-8, so write will retry as needed.

Implementations

impl<Inner: Write> Utf8Writer<Inner>

pub fn new(inner: Inner) -> Self

Construct a new instance of Utf8Writer wrapping inner.

pub fn into_inner(mut self: Self) -> Result<Inner>

Flush any pending output and return the inner stream.

Trait Implementations

impl<Inner: Write + AsRawFd> AsRawFd for Utf8Writer<Inner>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<Inner: Write + Debug> Debug for Utf8Writer<Inner>

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

Formats the value using the given formatter.

impl<Inner: Write> Write for Utf8Writer<Inner>

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.

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

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

pub 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.

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

Attempts to write an entire buffer into this writer.

pub 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.

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

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

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

Creates a "by reference" adaptor for this instance of Write.

impl<Inner: Write> WriteStr for Utf8Writer<Inner>

fn write_str(&mut self, s: &str) -> Result<()>

Like Write::write_all, but takes a &str, allowing implementors which require valid UTF-8 to avoid re-validating the data.