Struct TextWriter

pub struct TextWriter<W>
where
    W: Write,
{
    pub comma_style: CommaStyle,
    pub indentation: usize,
    pub escape_spaces: bool,
    /* private fields */
}

The (optionally pretty-printing) text syntax Preserves writer.

Fields

comma_style: CommaStyle

Selects a comma style to use when printing.

indentation: usize

Specifies indentation to use when pretty-printing; 0 disables pretty-printing.

escape_spaces: bool

An aid to use of printed terms in shell scripts: set true to escape spaces embedded in strings and symbols.

Implementations

impl TextWriter<&mut Vec<u8>>

pub fn fmt_value<N, Enc>( f: &mut Formatter<'_>, enc: &mut Enc, v: &Value<N>, ) -> Result<(), Error>

where N: NestedValue, Enc: DomainEncode<<N as NestedValue>::Embedded>,

Writes v to f using text syntax. Selects indentation mode based on f.alternate().

pub fn encode<N, Enc>(enc: &mut Enc, v: &N) -> Result<String, Error>

where N: NestedValue, Enc: DomainEncode<<N as NestedValue>::Embedded>,

Encode v to a String.

pub fn encode_iovalue(v: &IOValue) -> Result<String, Error>

Encode v to a String.

impl<W> TextWriter<W>

where W: Write,

pub fn new(w: W) -> TextWriter<W>

Construct a writer from the given byte sink w.

pub fn set_comma_style(self, v: CommaStyle) -> TextWriter<W>

Update selected comma-printing style.

pub fn set_escape_spaces(self, v: bool) -> TextWriter<W>

Update selected space-escaping style.

pub fn borrow_write(&mut self) -> &mut W

Borrow the underlying byte sink.

Trait Implementations

impl<W> Writer for TextWriter<W>

where W: Write,

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

Flushes any buffered output.

fn write<N, Enc>(&mut self, enc: &mut Enc, v: &N) -> Result<(), Error>

where N: NestedValue, Enc: DomainEncode<<N as NestedValue>::Embedded>,

Writes NestedValue v to the output of this Writer.

fn write_value<N, Enc>( &mut self, enc: &mut Enc, v: &Value<N>, ) -> Result<(), Error>

where N: NestedValue, Enc: DomainEncode<<N as NestedValue>::Embedded>,

Writes Value v to the output of this Writer.