Struct wlroots::cursor::Handle

pub struct Handle { /* fields omitted */ }

Methods

impl Handle

pub fn new() -> Self

Constructs a cursor::Handle that is always invalid. Calling run on this will always fail.

This is useful for pre-filling a value before it's provided by the server, or for mocking/testing.

pub fn run<F, R>(&self, runner: F) -> HandleResult<R> where     F: FnOnce(&mut Cursor) -> R,

Run a function on the referenced Cursor, if it still exists

If the Cursor is returned, then the Cursor is not deallocated.

Safety

By enforcing a rather harsh limit on the lifetime of the Cursor to a short lived scope of an anonymous function, this function ensures the Cursor does not live during a callback (at which point you would have aliased mutability).

Panics

This function will panic if multiple mutable borrows are detected. This will happen if you call upgrade directly within this callback, or if you run this function within the another run to the same Cursor.

So don't nest run calls or call this in a Cursor callback and everything will be ok :).

pub fn destroy(self)

Destroy the cursor that this handle refers to.

This will invalidate the other handles.

If the seat was previously destroyed, does nothing

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Handle

fn default() -> Self

Returns the "default value" for a type.

impl Debug for Handle

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

Formats the value using the given formatter.