Struct GroupBuilder 

pub struct GroupBuilder<'a> { /* private fields */ }

A group of a record being built.

Implementations

impl GroupBuilder<'_>

pub fn set(&mut self, name: &str, value: NodeType) -> Result<&mut Self>

Replaces a leaf, keeping the encoding of its default.

Arguments

• name - Field name.
• value - New value. It must be of the same type as the default.

Errors

Returns an error if the field doesn’t exist or the value has another type.

pub fn set_u32(&mut self, name: &str, value: u32) -> Result<&mut Self>

Replaces an unsigned leaf, keeping its type.

Games write integers and floats with their compact encoding when the value has one, so the leaf gets the optimized flag a decoded startpos would have.

Errors

Returns an error if the field doesn’t exist or isn’t an unsigned integer.

pub fn set_i32(&mut self, name: &str, value: i32) -> Result<&mut Self>

Replaces a signed leaf, keeping its type. See Self::set_u32 for its optimized flag.

Errors

Returns an error if the field doesn’t exist or isn’t a signed integer.

pub fn set_f32(&mut self, name: &str, value: f32) -> Result<&mut Self>

Replaces a float leaf. Only zero has a compact encoding: see Self::set_u32 for its optimized flag.

Errors

Returns an error if the field doesn’t exist or isn’t a float.

pub fn set_bool(&mut self, name: &str, value: bool) -> Result<&mut Self>

Replaces a boolean leaf, keeping its encoding.

Errors

Returns an error if the field doesn’t exist or isn’t a boolean.

pub fn set_str(&mut self, name: &str, value: &str) -> Result<&mut Self>

Replaces a string leaf (ASCII or UTF-16).

Errors

Returns an error if the field doesn’t exist or isn’t a string.

pub fn push_child(&mut self, node: NodeType) -> Result<&mut Self>

Adds a child to a free-form record.

Errors

Returns an error if the record isn’t free-form.

pub fn set_strings( &mut self, name: &str, values: Vec<String>, ) -> Result<&mut Self>

Replaces a string array leaf (ASCII or UTF-16).

Errors

Returns an error if the field doesn’t exist or isn’t a string array.

pub fn set_bytes(&mut self, name: &str, values: Vec<u8>) -> Result<&mut Self>

Replaces a byte array leaf (U8Array or I8Array).

Errors

Returns an error if the field doesn’t exist or isn’t a byte array.

pub fn set_u32s(&mut self, name: &str, values: Vec<u32>) -> Result<&mut Self>

Replaces an unsigned array leaf. Games write non-empty arrays with the compact encoding when every value has one, so the leaf gets the optimized flag a decoded startpos would have.

Errors

Returns an error if the field doesn’t exist or isn’t an unsigned array.

pub fn unset(&mut self, name: &str) -> Result<&mut Self>

Leaves an optional leaf out of the record.

Errors

Returns an error if the field doesn’t exist or isn’t optional.

pub fn set_record( &mut self, key: &str, record: Option<RecordNode>, ) -> Result<&mut Self>

Replaces a child record.

Arguments

• key - Child key (record name plus occurrence suffix).
• record - The new record, or None to leave an optional record out.

Errors

Returns an error if the group has no such child record, or None is given for a record that’s always present.

Trait Implementations

impl<'a> Clone for GroupBuilder<'a>

fn clone(&self) -> GroupBuilder<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for GroupBuilder<'a>

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

Formats the value using the given formatter.