Enum SurfaceError 

#[non_exhaustive]
pub enum SurfaceError {
    NotReady,
    FrameInFlight,
    NoFrame,
    BufferTooSmall {
        required: usize,
        actual: usize,
    },
    CursorTooLarge {
        limit: Size,
        requested: Size,
    },
    Backend(Box<dyn Error + Send + Sync + 'static>),
}

Failures from Surface.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NotReady

The surface has no valid size yet, or is not currently displayable.

FrameInFlight

Surface::acquire was called twice without an intervening present.

NoFrame

Surface::present was called without a preceding acquire.

BufferTooSmall

The backend handed over a buffer too small for the geometry it declared.

Fields

required: usize

Words the declared geometry requires.

actual: usize

Words actually available.

CursorTooLarge

A cursor sprite larger than the plane can hold.

Cursor planes are fixed-size, so this is a limit rather than a shortage. Refused rather than cropped: a pointer missing its lower half reads as a rendering bug, not as a hardware constraint.

Fields

limit: Size

The largest sprite the hardware accepts.

requested: Size

The sprite that was offered.

Backend(Box<dyn Error + Send + Sync + 'static>)

A platform-specific failure.

Implementations

impl SurfaceError

pub fn backend<E: Error + Send + Sync + 'static>(err: E) -> Self

Wraps a platform error without leaking its type into the core.

pub fn backend_msg(err: impl Display) -> Self

Wraps a platform error that is not Send + Sync, keeping only its message.

SurfaceError is deliberately thread-safe so applications can put it in an anyhow::Error or return it from main. Some platform errors are not — softbuffer’s, for one — so they get flattened to text here rather than infecting every caller.

Trait Implementations

impl Debug for SurfaceError

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

Formats the value using the given formatter.

impl Display for SurfaceError

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

Formats the value using the given formatter.

impl Error for SurfaceError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.