Struct SDL_AppResult

#[repr(transparent)]
pub struct SDL_AppResult(pub i32);

Available on crate feature dep_sdl3 only.

Return values for optional main callbacks.

Returning SDL_APP_SUCCESS or SDL_APP_FAILURE from [SDL_AppInit], [SDL_AppEvent], or [SDL_AppIterate] will terminate the program and report success/failure to the operating system. What that means is platform-dependent. On Unix, for example, on success, the process error code will be zero, and on failure it will be 1. This interface doesn’t allow you to return specific exit codes, just whether there was an error generally or not.

Returning SDL_APP_CONTINUE from these functions will let the app continue to run.

See Main callbacks in SDL3 for complete details.

Availability

This enum is available since SDL 3.2.0.

Known values (sdl3-sys)

Associated constant	Global constant	Description
CONTINUE	SDL_APP_CONTINUE	Value that requests that the app continue from the main callbacks.
SUCCESS	SDL_APP_SUCCESS	Value that requests termination with success from the main callbacks.
FAILURE	SDL_APP_FAILURE	Value that requests termination with error from the main callbacks.

Tuple Fields

0: i32

Implementations

impl SDL_AppResult

pub const CONTINUE: SDL_AppResult

Value that requests that the app continue from the main callbacks.

pub const SUCCESS: SDL_AppResult

Value that requests termination with success from the main callbacks.

pub const FAILURE: SDL_AppResult

Value that requests termination with error from the main callbacks.

Trait Implementations

impl Clone for SDL_AppResult

fn clone(&self) -> SDL_AppResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SDL_AppResult

fn default() -> SDL_AppResult

Returns the “default value” for a type.

impl From<SDL_AppResult> for i32

fn from(value: SDL_AppResult) -> i32

Converts to this type from the input type.

impl Hash for SDL_AppResult

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SDL_AppResult

fn cmp(&self, other: &SDL_AppResult) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SDL_AppResult

fn eq(&self, other: &SDL_AppResult) -> 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 PartialOrd for SDL_AppResult

fn partial_cmp(&self, other: &SDL_AppResult) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SDL_AppResult

impl Eq for SDL_AppResult

impl StructuralPartialEq for SDL_AppResult