Struct nobility::bin_encode::NbtWriter

pub struct NbtWriter { /* fields omitted */ }

This object owns the buffer that the NBT is being written into. It represents one document.

Example

use nobility::bin_encode::NbtWriter;

let mut writer = NbtWriter::new();
let mut root = writer.root("hello world");
// ... fill in contents ...
// finish() call is required.
root.finish();

let result: Vec<u8> = writer.finish();

Implementations

impl NbtWriter

pub fn new() -> NbtWriter

Creates a new empty writer.

pub fn root<'a>(&'a mut self, name: &str) -> CompoundWriter<'a>

Creates the root tag with the given name and returns a builder for it.

pub fn finish(self) -> Vec<u8>

Finalizes the NBT document and returns the buffer for use.

Panics

This method panics if root() was never called, as this would result in an invalid document.

Trait Implementations

impl Debug for NbtWriter

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

Formats the value using the given formatter.

impl Default for NbtWriter

pub fn default() -> NbtWriter

Returns the "default value" for a type.