Struct hcl::format::Formatter

pub struct Formatter<'a, W> { /* private fields */ }

A pretty printing HCL formatter.

Examples

Format an HCL block as string:

use hcl::format::{Format, Formatter};

let mut buf = Vec::new();
let mut formatter = Formatter::new(&mut buf);

let block = hcl::Block::builder("user")
    .add_label("johndoe")
    .add_attribute(("age", 34))
    .add_attribute(("email", "johndoe@example.com"))
    .build();

block.format(&mut formatter)?;

let expected = r#"
user "johndoe" {
  age = 34
  email = "johndoe@example.com"
}
"#.trim_start();

let formatted = String::from_utf8(buf)?;

assert_eq!(formatted, expected);

The builder() method can be used to construct a custom Formatter for use with a Serializer:

use hcl::{format::Formatter, ser::Serializer};

let formatter = Formatter::builder()
    .indent(b"  ")
    .dense(false)
    .build(&mut writer);

let ser = Serializer::with_formatter(formatter);

Implementations

impl<'a, W> Formatter<'a, W>

pub fn new(writer: W) -> Formatter<'a, W>

Creates a new Formatter which writes HCL to the provided writer.

pub fn builder() -> FormatterBuilder<'a, W>

Creates a new FormatterBuilder to start building a new Formatter.

pub fn into_inner(self) -> W

Consumes self and returns the wrapped writer.

Trait Implementations

impl<'a, W> Write for Formatter<'a, W>where
    W: Write,

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.

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

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

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.

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

Attempts to write an entire buffer into this writer.

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.

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

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

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adapter for this instance of Write.