Struct raw_window_handle::ActiveHandle

pub struct ActiveHandle<'a>(ActiveHandle<'a>);

Represents a live window handle.

This is carried around by the Active type, and is used to ensure that the application doesn’t enter the suspended state while there are still live window handles. See documentation on the Active type for more information.

On non-Android platforms, this is a ZST. On Android, this is a reference counted handle that keeps the application active while it is alive.

Tuple Fields

0: ActiveHandle<'a>

Implementations

impl ActiveHandle<'_>

pub fn new() -> Self

Create a new ActiveHandle.

This is safe because the handle is always active.

Example

use raw_window_handle::ActiveHandle;
let handle = ActiveHandle::new();

impl ActiveHandle<'_>

pub unsafe fn new_unchecked() -> Self

Create a new freestanding active handle.

This function acts as an “escape hatch” to allow the user to create a live window handle without having to go through the Active type. This is useful if the user knows that the application is active, and wants to create a live window handle without having to go through the Active type.

Safety

The application must actually be active.

Example

use raw_window_handle::ActiveHandle;

// Create a freestanding active handle.
// SAFETY: The application must actually be active.
let handle = unsafe { ActiveHandle::new_unchecked() };

Trait Implementations

impl<'a> Clone for ActiveHandle<'a>

fn clone(&self) -> ActiveHandle<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ActiveHandle<'a>

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

Formats the value using the given formatter.