Struct wlroots::output::layout::Handle

pub struct Handle { /* fields omitted */ }

A handle to an output::layout::Layout.

Methods

impl Handle

pub fn new() -> Self

Constructs a new 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 Layout) -> R,

Run a function on the referenced output::layout::Layout, if it still exists

Returns the result of the function, if successful.

Safety

By enforcing a rather harsh limit on the lifetime of the output::layout::Layout to a short lived scope of an anonymous function, this function ensures the output::layout::Layout does not live longer than it exists (because the lifetime is controlled by the user).

pub fn destroy(self)

Destroy the output layout that this handle refers to.

This will invalidate the other handles, including the ones held by output::Outputs.

If the output layout 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 Eq for Handle

impl Default for Handle

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Handle> for Handle

fn eq(&self, other: &Handle) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Handle

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

Formats the value using the given formatter.