Struct jomini::TextWriter

pub struct TextWriter<W, V> { /* fields omitted */ }

Write data in PDS format.

Instantiated via TextWriterBuilder

Implementations

impl<W, V> TextWriter<W, V> where
    W: Write,
    V: WriteVisitor, 

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

Get inner writer, keeping ownership

pub fn into_inner(self) -> W

Consumes this Writer, returning the underlying writer

pub fn expecting_key(&self) -> bool

Returns true if the next write event would be a key

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

Write out the start of an object

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

Write the start of a hidden object (eg: data = { 10 a=b })

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

Write out the start of an array

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

Write the end of an array or object

pub fn write_bool(&mut self, data: bool) -> Result<(), Error>

Write a boolean

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"hello")?;
writer.write_bool(true)?;
writer.write_unquoted(b"foo")?;
writer.write_bool(false)?;
assert_eq!(&out, b"hello=yes\nfoo=no\n");

pub fn write_operator(&mut self, data: Operator) -> Result<(), Error>

Write an non-equal operator

use jomini::{Operator, TextWriterBuilder};
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"a")?;
writer.write_operator(Operator::LessThan)?;
writer.write_unquoted(b"b")?;
assert_eq!(&out, b"a < b\n");

pub fn write_unquoted(&mut self, data: &[u8]) -> Result<(), Error>

Write bytes directly to the writer.

The contents of the bytes are not checked, so it is up to the caller to ensure that the data is a valid unquoted field (no spaces or control characters).

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"a")?;
writer.write_unquoted(b"b")?;
assert_eq!(&out, b"a=b\n");

pub fn write_quoted(&mut self, data: &[u8]) -> Result<(), Error>

Write a field to be encapsulated in quotes.

Unlike the unquoted variant, this method will inspect the data to ensure everything is properly escaped, like quotes and escape characters. And will trim trailing newlines. The textual data to write out is assumed to already be in the correct encoding (windows-1252 or UTF-8)

Also if one tries to write a quoted field as a key this method will redirect to the unquoted variant

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_quoted(b"name")?;
writer.write_quoted(br#"captain "joe" rogers"#)?;
assert_eq!(&out, b"name=\"captain \\\"joe\\\" rogers\"\n");

pub fn write_i32(&mut self, data: i32) -> Result<(), Error>

Write a signed 32bit integer.

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"stability")?;
writer.write_i32(-3);
assert_eq!(&out, b"stability=-3\n");

pub fn write_u32(&mut self, data: u32) -> Result<(), Error>

Write an unsigned 32bit integer.

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"stability")?;
writer.write_u32(3);
assert_eq!(&out, b"stability=3\n");

pub fn write_u64(&mut self, data: u64) -> Result<(), Error>

Write an unsigned 64bit integer.

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"seed")?;
writer.write_u64(1000000000000);
assert_eq!(&out, b"seed=1000000000000\n");

pub fn write_f32(&mut self, data: f32) -> Result<(), Error>

Write a 32 bit floating point according to the visitor

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"morale")?;
writer.write_f32(4.566);
assert_eq!(&out, b"morale=4.566\n");

pub fn write_f64(&mut self, data: f64) -> Result<(), Error>

Write a 64 bit floating point according to the visitor

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"strength")?;
writer.write_f64(6790.35609);
assert_eq!(&out, b"strength=6790.35609\n");

pub fn write_header(&mut self, header: &[u8]) -> Result<(), Error>

Write a header.

It is undefined if the next commands do not write out the start of an array or object

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"color")?;
writer.write_header(b"rgb")?;
writer.write_array_start()?;
writer.write_i32(100)?;
writer.write_i32(200)?;
writer.write_i32(50)?;
writer.write_end()?;
assert_eq!(&out, b"color=rgb {\n  100 200 50\n}\n");

pub fn write_date(&mut self, data: PdsDateFormatter) -> Result<(), Error>

Write a date formatted in the game style

use jomini::{common::{Date, PdsDate}, TextWriterBuilder};
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
let date = Date::from_ymd(1444, 11, 11);
writer.write_unquoted(b"start")?;
writer.write_date(date.game_fmt())?;
assert_eq!(&out, b"start=1444.11.11\n");

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

Write formatted data

Typically not invoked directly but instead through the write! macro

use jomini::TextWriterBuilder;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_unquoted(b"start")?;
write!(writer, "unknown_{}", 5)?;
assert_eq!(&out, b"start=unknown_5\n");

pub fn write_tape(&mut self, tape: &TextTape<'_>) -> Result<(), Error>

Writes a text tape

Formatting is not preserved.

use jomini::{TextTape, TextWriterBuilder};
let tape = TextTape::from_slice(b"hello=world")?;
let mut out: Vec<u8> = Vec::new();
let mut writer = TextWriterBuilder::new().from_writer(&mut out);
writer.write_tape(&tape)?;
assert_eq!(&out, b"hello=world\n");

Trait Implementations

impl<W: Debug, V: Debug> Debug for TextWriter<W, V>

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

Formats the value using the given formatter.