Struct nobility::bin_encode::CompoundWriter

pub struct CompoundWriter<'a> { /* fields omitted */ }

A builder for a TAG_Compound, allowing fields to be added sequentially.

Example

let mut compound = some_compound;
compound.field("Name").string("Alice");

let mut pos = compound.compound_field("Position");
pos.field("X").int(34);
pos.field("Y").int(12);
pos.finish();

// finish() call is required.
compound.finish();

Panics

This object will panic on drop if finish() is not called. Otherwise, an invalid NBT document would be generated.

Implementations

impl<'a> CompoundWriter<'a>

pub fn field<'b>(&'b mut self, name: &'b str) -> TagWriter<'b>

Create a new field and return a builder for filling in its value.

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

Creates a compound field. The reason to use this is that .field(name).compound() has too short of a lifetime for the intermediate TagWriter, and would have to be spread across multiple variables, causing verbose code.

pub fn compound_list_field<'b>(
    &'b mut self,
    name: &'b str
) -> CompoundListWriter<'b>

Creates a list of compounds. The reason to use this is that .field(name).compound_list() has too short of a lifetime for the intermediate TagWriter, and would have to be spread across multiple variables, causing verbose code.

pub fn finish(self)

Finishes the compound tag. This must be called after you're done appending elements, or a panic will occur on drop.

Trait Implementations

impl<'a> Debug for CompoundWriter<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for CompoundWriter<'a>

pub fn drop(&mut self)

Executes the destructor for this type.