Enum raw_window_handle::HandleError

#[non_exhaustive]
pub enum HandleError {
    NotSupported,
    Unavailable,
}

An error that can occur while fetching a display or window handle.

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.

NotSupported

The underlying handle cannot be represented using the types in this crate.

This may be returned if the underlying window system does not support any of the representative C window handles in this crate. For instance, if you were using a pure Rust library to set up X11 (like x11rb), you would not be able to use any of the RawWindowHandle variants, as they all represent C types.

Another example would be a system that isn’t supported by raw-window-handle yet, like some game consoles.

In the event that this error is returned, you should try to use the underlying window system’s native API to get the handle you need.

Unavailable

The underlying handle is not available.

In some cases the underlying window handle may become temporarily unusable. For example, on Android, the native window pointer can arbitrarily be replaced or removed by the system. In this case, returning a window handle would be disingenuous, as it would not be usable. A similar situation can occur on Wayland for the layer shell windows.

In the event that this error is returned, you should wait until the handle becomes available again.

Trait Implementations

impl Clone for HandleError

fn clone(&self) -> HandleError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HandleError

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

Formats the value using the given formatter.

impl Display for HandleError

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

Formats the value using the given formatter.

impl Error for HandleError

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

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.