Struct StartposLayout 

pub struct StartposLayout { /* private fields */ }

Layouts of every record path of a startpos.

Implementations

impl StartposLayout

pub fn from_esf(startpos: &ESF) -> Result<Self>

Extracts the layouts of every record of a startpos.

Arguments

• startpos - A game-built startpos.

Errors

Returns an error if the root isn’t a record.

pub fn from_esfs( startposes: impl IntoIterator<Item = Result<ESF>>, ) -> Result<Self>

Extracts the layouts of every record of several startposes, as if their records were in a single one: defaults are the most common values across all of them. Startposes are taken one at a time, so only one needs to be in memory.

Arguments

• startposes - Game-built startposes of the same game, or the errors getting them.

Errors

Returns the first error getting a startpos, or an error if a root isn’t a record.

pub fn with_fallback(self, fallback: &StartposLayout) -> Self

Adds what this layout lacks from another one, like records a campaign never uses from a layout merged from all the game’s campaigns:

• Paths it doesn’t have, and paths it has only seen empty (arrays without items).
• Slots its records lack, after the slot they follow in the other layout. They’re optional and start out of built records, so records only have them when a generator sets them.

Everything this layout has keeps its own layout and defaults.

pub fn load(path: &Path) -> Result<Self>

Loads a layout file.

Errors

Returns an error if the file can’t be read or isn’t a valid layout.

pub fn save(&self, path: &Path) -> Result<()>

Saves the layout to a file.

Errors

Returns an error if the file can’t be written.

pub fn record(&self, path: &str) -> Option<&RecordLayout>

Returns the layout of a record path.

pub fn builder(&self, path: &str) -> Result<RecordBuilder<'_>>

Starts building a record from its layout.

Arguments

• path - Path of the record.

Returns

A builder with every slot at its default: one group for normal records, none for arrays.

Errors

Returns an error if the layout has no such path.

pub fn default_record(&self, path: &str) -> Result<RecordNode>

Builds a record with every slot at its default.

Errors

Returns an error if the layout lacks the path or one of its child records.

pub fn read<'a>( &'a self, path: &str, record: &'a RecordNode, ) -> Result<Vec<GroupView<'a>>>

Reads the groups of a record through the layout of its path.

Arguments

• path - Path of the record.
• record - The record to read.

Errors

Returns an error if the path has no layout, its layout is free-form, or a group doesn’t fit it.

pub fn read_single<'a>( &'a self, path: &str, record: &'a RecordNode, ) -> Result<GroupView<'a>>

Reads the only group of a record through the layout of its path.

Arguments

• path - Path of the record.
• record - The record to read.

Errors

Returns an error if the record doesn’t fit its layout or has no group.

pub fn read_items<'a>( &'a self, array_path: &str, parent: &GroupView<'a>, array_key: &str, item_key: &str, ) -> Result<Vec<(GroupView<'a>, GroupView<'a>)>>

Reads the items of an array record child of a group: each array group, with its item record’s only group.

Arguments

• array_path - Path of the array record.
• parent - The group holding the array.
• array_key - Key of the array record in the parent.
• item_key - Key of the item record in each array group.

Returns

The array group and the item’s group of each item. None if the parent lacks the array.

Errors

Returns an error if a record doesn’t fit its layout, or an array group lacks its item.

pub fn raw_record( &self, path: &str, children: Vec<NodeType>, ) -> Result<RecordNode>

Builds a record with the given children as its only group, as they are. For records whose shape varies too much for slots, like lists of buildings.

Errors

Returns an error if the layout has no such path.

Trait Implementations

impl Clone for StartposLayout

fn clone(&self) -> StartposLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartposLayout

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

Formats the value using the given formatter.

impl Default for StartposLayout

fn default() -> StartposLayout

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StartposLayout

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StartposLayout

fn eq(&self, other: &StartposLayout) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for StartposLayout

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StartposLayout