Struct World 

pub struct World { /* private fields */ }

A validated world source tree.

A World can only be produced by a load, such as load or load_with, so every one has passed validation; its parts are read through accessors and cannot be changed in place.

let planes = world.planes; // the fields are private

Implementations

impl World

pub const fn profile(&self) -> &Profile

pub const fn planes(&self) -> &BTreeMap<String, Plane>

Planes by ID.

pub const fn definitions(&self) -> &BTreeMap<(String, String), Definition>

Definitions keyed by (type, id).

pub const fn source_digest(&self) -> [u8; 32]

SHA-256 over every file read, as defined in docs/spec/PACK.md.

pub const fn files(&self) -> &BTreeMap<String, SourceFile>

Every file the load read, which World::source_digest covers, by root-relative /-separated path, each with its length and SHA-256 as read. An overlay’s files are listed as the overlay gave them. A file the layout lets the loader ignore, such as one under profile/ that the profile does not name, is not read, so it is not listed, and changing it does not change the digest.

pub const fn object_uids(&self) -> &BTreeMap<String, ObjectLocation>

Every object uid of the world, with where its object is. Uids are unique in the whole world, so a uid alone names one object.

pub fn object_location(&self, uid: &str) -> Option<&ObjectLocation>

Where the object with uid is.

pub fn object(&self, uid: &str) -> Option<&Object>

The object with uid.

Trait Implementations

impl Clone for World

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for World

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

Formats the value using the given formatter.

impl PartialEq for World

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for World