Struct App 

pub struct App { /* private fields */ }

The application: a world plus the loop state that drives it.

Implementations

impl App

pub fn new() -> Self

An app holding an empty world.

pub fn in_tree(self, tree: StateTree) -> Self

An app that reads and writes under tree: its blobs, its settings, its saves, and the caches it warms. Without one the app runs a world and touches no disk.

pub fn state_tree(&self) -> Option<&StateTree>

The state tree this app runs against, if it has one.

pub fn from_world(world: World) -> Self

An app holding an already-built world, ready to start or run.

pub fn from_blob(path: &Path) -> Result<Self, StartupError>

An app holding the world compiled into the blob file at path. Overflow payload blobs are its siblings named by index, so a world written to data/0 reads data/1, data/2, … beside it.

Derives the state tree from the blob’s own directory, so the settings and saves the app writes land with the world it read rather than under the directory it was launched from. A caller with a tree of its own builds the app with in_tree instead. The world’s own AppConfig.home overrides either at start.

pub fn load_blob(&mut self) -> Result<(), CnResult>

Load assets and blob payload data from the primary blob under this app’s state tree, and populate the world. Replaces any previously loaded world. NoStateRoot when the app has no tree to read from.

pub fn primary_blob(&self) -> Option<PathBuf>

The primary blob this app reads: blob 0 under its tree’s data/. None for an app with no tree.

pub fn world(&self) -> &World

Borrow the app’s world.

pub fn world_mut(&mut self) -> &mut World

Mutably borrow the app’s world.

pub fn shutdown_token(&self) -> ShutdownToken

clone of the root cancellation token. Pass this to systems or the ctrl+c handler so they all share a single cancellation source

pub fn start(&mut self) -> Result<(), CnResult>

Build the world’s systems and run their init. Must run once, before the first step.

pub fn into_world(self) -> World

Take the app’s world back, so a caller can put it on a different loop.

pub fn load_world(&mut self, world: World)

Replace the current world and reset to Created so start() can be called again. Used to load a new scene at runtime.

pub fn run(self) -> Result<(), CnResult>

Run this app on the runtime loop with default options, consuming it.

Trait Implementations

impl Debug for App

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

Formats the value using the given formatter.

impl Default for App

fn default() -> Self

Returns the “default value” for a type.

impl Driver for App

fn start(&mut self) -> Result<(), CnResult>

Build the world’s systems and run their init.

fn run(self: Box<Self>) -> Result<(), CnResult>

Run the world until it ends.

fn into_world(self: Box<Self>) -> World

Take the world back instead of running it.