Struct sval_json::Formatter

pub struct Formatter<W> { /* fields omitted */ }

A stream for writing structured data as json.

The stream internally wraps a std::fmt::Write.

Examples

Create an owned json stream:

use sval::stream::OwnedStream;
use sval_json::Formatter;

let mut stream = OwnedStream::new(Formatter::new(String::new()));
stream.any(42)?;
let json = stream.into_inner().end()?;

assert_eq!("42", json);

Methods

impl<W> Formatter<W> where
    W: Write, 

pub fn new(out: W) -> Self

Create a new json stream.

pub fn is_valid(&self) -> bool

Whether the stream has seen a complete, valid json structure.

pub fn end(self) -> Result<W, End<Self>>

Complete the stream and return the inner writer.

If the writer contains incomplete json then this method will fail. The returned error can be used to pull the original stream back out.

pub fn into_inner_unchecked(self) -> W

Get the inner writer back out of the stream without ensuring it's valid.

Trait Implementations

impl<W> Stream for Formatter<W> where
    W: Write, 

fn fmt(&mut self, v: Arguments) -> Result

Stream a format.

fn i64(&mut self, v: i64) -> Result

Stream a signed integer.

fn u64(&mut self, v: u64) -> Result

Stream an unsigned integer.

fn f64(&mut self, v: f64) -> Result

Stream a floating point value.

fn bool(&mut self, v: bool) -> Result

Stream a boolean.

fn char(&mut self, v: char) -> Result

Stream a unicode character.

fn str(&mut self, v: &str) -> Result

Stream a UTF-8 string slice.

fn none(&mut self) -> Result

Stream an empty value.

fn seq_begin(&mut self, _: Option<usize>) -> Result

Begin a sequence.

fn seq_elem(&mut self) -> Result

Begin a sequence element.

fn seq_end(&mut self) -> Result

End a sequence.

fn map_begin(&mut self, _: Option<usize>) -> Result

Begin a map.

fn map_key(&mut self) -> Result

Begin a map key.

fn map_value(&mut self) -> Result

Begin a map value.

fn map_end(&mut self) -> Result

End a map.

fn i128(&mut self, v: i128) -> Result<(), Error>

Stream a 128bit signed integer.

fn u128(&mut self, v: u128) -> Result<(), Error>

Stream a 128bit unsigned integer.