Struct sise::SpacedStringWriter

pub struct SpacedStringWriter<'a, 'b> { /* fields omitted */ }

Writer that writes everything into a multi-line string.

Example

use sise::Writer as _;

let style = sise::SpacedStringWriterStyle {
   line_break: "\n",
   indentation: " ",
};

let mut result = String::new();
let mut writer = sise::SpacedStringWriter::new(style, &mut result);

writer.begin_list(&sise::SpacedStringWriterNodeOptions::default()).unwrap();
writer.write_atom("example", &sise::SpacedStringWriterNodeOptions::default()).unwrap();
writer.begin_list(&sise::SpacedStringWriterNodeOptions::default()).unwrap();
// Write the three atoms in a single line.
writer.write_atom("1", &sise::SpacedStringWriterNodeOptions::default()).unwrap();
writer.write_atom("2", &sise::SpacedStringWriterNodeOptions::default()).unwrap();
writer.write_atom("3", &sise::SpacedStringWriterNodeOptions::default()).unwrap();
writer.end_list(&sise::VoidWriterOptions).unwrap();
writer.begin_list(&sise::SpacedStringWriterNodeOptions::default()).unwrap();
// Write the three atoms in a single line.
writer.write_atom("a", &sise::SpacedStringWriterNodeOptions::default()).unwrap();
writer.write_atom("b", &sise::SpacedStringWriterNodeOptions::default()).unwrap();
writer.write_atom("c", &sise::SpacedStringWriterNodeOptions::default()).unwrap();
writer.end_list(&sise::VoidWriterOptions).unwrap();
writer.end_list(&sise::VoidWriterOptions).unwrap();
writer.finish(&sise::VoidWriterOptions).unwrap();

let expected_result = "(\n example\n (\n  1\n  2\n  3\n )\n (\n  a\n  b\n  c\n )\n)";
assert_eq!(result, expected_result);

Using SpacedStringWriterNodeOptions allows to write specified nodes in a single line:

use sise::Writer as _;

let style = sise::SpacedStringWriterStyle {
   line_break: "\n",
   indentation: " ",
};

let mut result = String::new();
let mut writer = sise::SpacedStringWriter::new(style, &mut result);

writer.begin_list(&sise::SpacedStringWriterNodeOptions::default()).unwrap();
writer.write_atom("example", &sise::SpacedStringWriterNodeOptions::no_break_line()).unwrap();
writer.begin_list(&sise::SpacedStringWriterNodeOptions::break_line()).unwrap();
// Write the three atoms in a single line.
writer.write_atom("1", &sise::SpacedStringWriterNodeOptions::no_break_line()).unwrap();
writer.write_atom("2", &sise::SpacedStringWriterNodeOptions::no_break_line()).unwrap();
writer.write_atom("3", &sise::SpacedStringWriterNodeOptions::no_break_line()).unwrap();
writer.end_list(&sise::VoidWriterOptions).unwrap();
writer.begin_list(&sise::SpacedStringWriterNodeOptions::break_line()).unwrap();
// Write the three atoms in a single line.
writer.write_atom("a", &sise::SpacedStringWriterNodeOptions::no_break_line()).unwrap();
writer.write_atom("b", &sise::SpacedStringWriterNodeOptions::no_break_line()).unwrap();
writer.write_atom("c", &sise::SpacedStringWriterNodeOptions::no_break_line()).unwrap();
writer.end_list(&sise::VoidWriterOptions).unwrap();
writer.end_list(&sise::VoidWriterOptions).unwrap();
writer.finish(&sise::VoidWriterOptions).unwrap();

let expected_result = "(example\n (1 2 3)\n (a b c)\n)";
assert_eq!(result, expected_result);

Methods

impl<'a, 'b> SpacedStringWriter<'a, 'b>

pub fn new(style: SpacedStringWriterStyle<'a>, dst: &'b mut String) -> Self

Trait Implementations

impl<'a, 'b> Writer for SpacedStringWriter<'a, 'b>

type Result = ()

Type of data returned by the writer.

type Error = Infallible

The error type that may be produced while writing.

type AtomOptions = SpacedStringWriterNodeOptions

Type of options that can be passed to write_atom.

type BeginListOptions = SpacedStringWriterNodeOptions

Type of options that can be passed to begin_list.

type EndListOptions = VoidWriterOptions

Type of options that can be passed to end_list.

type FinishOptions = VoidWriterOptions

Type of options that can be passed to finish.

fn write_atom(
    &mut self,
    atom: &str,
    opts: &SpacedStringWriterNodeOptions
) -> Result<(), Infallible>

Writes an atom.

fn begin_list(
    &mut self,
    opts: &SpacedStringWriterNodeOptions
) -> Result<(), Infallible>

Begins a list.

fn end_list(&mut self, _opts: &VoidWriterOptions) -> Result<(), Infallible>

Ends a list.

fn finish(self, _opts: &VoidWriterOptions) -> Result<(), Infallible>

Consumes the writer and returns the result. It must be called only after the root node has been completely written.