Struct wlroots::compositor::Handle

pub struct Handle { /* fields omitted */ }

Methods

impl Handle

pub fn new() -> Self

Constructs a new compositor::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 Compositor) -> R,

Run a function on the referenced Compositor, if it still exists.

Returns the result of the function, if successful.

Safety

By enforcing a rather harsh limit on the lifetime of the Compositor to a short lived scope of an anonymous function, this function ensures the Compositor does not live longer than it exists.

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 Output.

So don't nest run calls and everything will be ok :).

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 Debug for Handle

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

Formats the value using the given formatter.