Struct StringTextWriter 

pub struct StringTextWriter<'a> { /* private fields */ }

Text writer over a borrowed String with configurable line endings.

Implementations

impl<'a> StringTextWriter<'a>

pub const fn new(output: &'a mut String) -> Self

Creates a writer over output.

Parameters

• output: Destination string.

Returns

A string text writer using LF line endings.

pub const fn with_line_ending(self, line_ending: LineEnding) -> Self

Sets the line ending for this writer.

Parameters

• line_ending: Line ending to use for subsequent lines.

Returns

This writer with the configured line ending.

pub fn get_ref(&self) -> &String

Returns the wrapped string.

Returns

A shared reference to the destination string.

pub fn get_mut(&mut self) -> &mut String

Returns the wrapped string mutably.

Returns

A mutable reference to the destination string.

Trait Implementations

impl<'a> Debug for StringTextWriter<'a>

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

Formats the value using the given formatter.

impl TextWrite for StringTextWriter<'_>

type Error = Infallible

Error returned by this text sink.

fn line_ending(&self) -> LineEnding

Returns the configured line ending for TextWrite::write_line.

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

Writes one Unicode scalar value.

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

Writes a slice of Unicode scalar values.

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

Writes a string slice.

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

Writes a line followed by the configured line ending.

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

Flushes buffered text to the underlying sink.