Trait TextWrite 

pub trait TextWrite {
    type Error;

    // Required methods
    fn write_char(&mut self, ch: char) -> Result<(), Self::Error>;
    fn write_chars(&mut self, chars: &[char]) -> Result<(), Self::Error>;
    fn write_str(&mut self, text: &str) -> Result<(), Self::Error>;
    fn write_line(&mut self, line: &str) -> Result<(), Self::Error>;
    fn flush(&mut self) -> Result<(), Self::Error>;

    // Provided method
    fn line_ending(&self) -> LineEnding { ... }
}

Writes Unicode text to a text sink.

TextWrite accepts Rust Unicode text and delegates byte encoding, storage, logging, or other sink-specific behavior to the concrete implementation.

Required Associated Types

type Error

Error returned by this text sink.

Required Methods

fn write_char(&mut self, ch: char) -> Result<(), Self::Error>

Writes one Unicode scalar value.

Parameters

• ch: Character to write.

Errors

Returns an implementation-specific error when the character cannot be accepted by the sink.

fn write_chars(&mut self, chars: &[char]) -> Result<(), Self::Error>

Writes a slice of Unicode scalar values.

Parameters

• chars: Characters to write in order.

Errors

Returns an implementation-specific error when any character cannot be accepted by the sink.

fn write_str(&mut self, text: &str) -> Result<(), Self::Error>

Writes a string slice.

Parameters

• text: Text to write.

Errors

Returns an implementation-specific error when the text cannot be accepted by the sink.

fn write_line(&mut self, line: &str) -> Result<(), Self::Error>

Writes a line followed by the configured line ending.

Parameters

• line: Line content to write. The configured line ending is appended.

Errors

Returns an implementation-specific error when the line or line ending cannot be accepted by the sink.

fn flush(&mut self) -> Result<(), Self::Error>

Flushes buffered text to the underlying sink.

Errors

Returns an implementation-specific error when flushing fails.

Provided Methods

fn line_ending(&self) -> LineEnding

Returns the configured line ending for TextWrite::write_line.

Returns

The configured line ending. Implementations default to LineEnding::Lf.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl TextWrite for String

type Error = Infallible

fn write_char(&mut self, ch: char) -> Result<(), Self::Error>

fn write_chars(&mut self, chars: &[char]) -> Result<(), Self::Error>

fn write_str(&mut self, text: &str) -> Result<(), Self::Error>

fn write_line(&mut self, line: &str) -> Result<(), Self::Error>

fn flush(&mut self) -> Result<(), Self::Error>

Implementors

impl TextWrite for StringTextWriter<'_>

type Error = Infallible

impl<W> TextWrite for EncodedTextWriter<W>

where W: Write,

type Error = Error

impl<W> TextWrite for Utf8TextWriter<W>

where W: Write,

type Error = Error