Struct nobility::bin_encode::CompoundListWriter

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

A builder for a TAG_List of TAG_Compounds.

Example

let mut player = some_compound;
let mut list = player.compound_list_field("Friends");

{
    let mut element = list.element();
    element.field("Name").string("Alice");
    element.field("Level").int(20);
    element.finish();
}

{
    let mut element = list.element();
    element.field("Name").string("Steve");
    element.field("Level").int(17);
    element.finish();
}

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

Panics

This object will panic on drop if finish() is not called.

Implementations

impl<'a> CompoundListWriter<'a>

pub fn element(&mut self) -> CompoundWriter<'_>

Start a new element in the list, returning a CompoundWriter to build it. finish must be called on the builder before additional elements can be added.

pub fn finish(self)

Must be called before the builder goes out of scope, otherwise an invalid NBT document would be generated.

Trait Implementations

impl<'a> Debug for CompoundListWriter<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for CompoundListWriter<'a>

pub fn drop(&mut self)

Executes the destructor for this type.