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 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, CnResult>

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.

Anchors the state tree beside the blob unless a host already installed one, so the settings and saves the app writes land with the world it read rather than under the directory it was launched from. The world’s own AppConfig.home overrides that at start.

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

load assets and blob payload data from the primary blob and populate the world. Replaces any previously loaded world

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 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<()>

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.