Enum tetra::error::TetraError

pub enum TetraError {
    PlatformError(String),
    FailedToLoadAsset {
        reason: Error,
        path: PathBuf,
    },
    InvalidTexture(ImageError),
    InvalidShader(String),
    InvalidSound(DecoderError),
    NotEnoughData {
        expected: usize,
        actual: usize,
    },
    NoAudioDevice,
    FailedToChangeDisplayMode(String),
    // some variants omitted
}

The types of error that can occur in a Tetra game.

Note that if you match on this enum, you will be forced to add a wildcard arm by the compiler. This is so that if a new error type is added later on, it will not break your code.

Variants

PlatformError(String)

Returned when the underlying platform returns an unexpected error. This usually isn't something your game can reasonably be expected to recover from.

FailedToLoadAsset

Returned when your game fails to load an asset. This is usually caused by an incorrect file path, or some form of permission issues.

Fields of FailedToLoadAsset

reason: Error

The underlying reason for the error.

path: PathBuf

The path to the asset that failed to load.

InvalidTexture(ImageError)

Returned when a texture's data is invalid.

InvalidShader(String)

Returned when a shader fails to compile.

InvalidSound(DecoderError)

Returned when a sound cannot be decoded.

NotEnoughData

Returned when not enough data is provided to fill a buffer. This may happen if you're creating a texture from raw data and you don't provide enough data.

Fields of NotEnoughData

expected: usize

The number of bytes that were expected.

actual: usize

The number of bytes that were provided.

NoAudioDevice

Returned when trying to play back audio without an available device.

FailedToChangeDisplayMode(String)

Returned when your game tried to change the display settings (e.g. fullscreen, vsync) but was unable to do so.

Trait Implementations

impl Debug for TetraError

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

Formats the value using the given formatter.

impl Display for TetraError

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

Formats the value using the given formatter.

impl Error for TetraError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.