Enum AppExit

pub enum AppExit {
    Success,
    Error(NonZeroU8),
}

An event that indicates the App should exit. If one or more of these are present at the end of an update, the runner will end and (maybe) return control to the caller.

This event can be used to detect when an exit is requested. Make sure that systems listening for this event run before the current update ends.

Portability

This type is roughly meant to map to a standard definition of a process exit code (0 means success, not 0 means error). Due to portability concerns (see ExitCode and process::exit) we only allow error codes between 1 and 255.

Variants

Success

App exited without any problems.

Error(NonZeroU8)

The App experienced an unhandleable error. Holds the exit code we expect our app to return.

Implementations

impl AppExit

pub const fn error() -> Self

Creates a AppExit::Error with a error code of 1.

pub const fn is_success(&self) -> bool

Returns true if self is a AppExit::Success.

pub const fn is_error(&self) -> bool

Returns true if self is a AppExit::Error.

pub const fn from_code(code: u8) -> Self

Creates a AppExit from a code.

When code is 0 a AppExit::Success is constructed otherwise a AppExit::Error is constructed.

Trait Implementations

impl Clone for AppExit

fn clone(&self) -> AppExit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for AppExit

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Debug for AppExit

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

Formats the value using the given formatter.

impl Default for AppExit

fn default() -> AppExit

Returns the “default value” for a type.

impl From<u8> for AppExit

fn from(value: u8) -> Self

Converts to this type from the input type.

impl PartialEq for AppExit

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Termination for AppExit

fn report(self) -> ExitCode

Is called to get the representation of the value as status code. This status code is returned to the operating system.

impl Eq for AppExit

impl Event for AppExit

where Self: Send + Sync + 'static,

impl StructuralPartialEq for AppExit