Skip to main content

MutterCompositor

Struct MutterCompositor 

Source
pub struct MutterCompositor { /* private fields */ }
Expand description

Headless mutter instance.

Implementations§

Source§

impl MutterCompositor

Source

pub fn new() -> Self

Construct but do not start. Generates the session id and computes where the Wayland socket and runtime dir will live. No I/O.

Source

pub fn state(&self) -> Arc<MutterState>

Returns the shared Arc<MutterState> for passing to sibling backends.

§Panics

Panics if called before CompositorRuntime::start has completed, or after CompositorRuntime::stop. Callers are expected to follow the fixed sequence: new()start().await?state().

Trait Implementations§

Source§

impl CompositorRuntime for MutterCompositor

Source§

fn start<'life0, 'life1, 'async_trait>( &'life0 mut self, resolution: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Spawn the compositor at the requested virtual-display size (or the backend default when None) and wait for it to be ready. After this returns successfully, wayland_display() and runtime_dir() must point at a live Wayland socket.
Source§

fn stop<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Stop the compositor, tearing down all child processes and cleaning up the runtime directory. Safe to call on an un-started or already-stopped backend.
Source§

fn id(&self) -> &str

Session identifier, used in log fields and default output paths.
Source§

fn wayland_display(&self) -> &str

Wayland display socket name (e.g. wayland-wd-abc12345).
Source§

fn runtime_dir(&self) -> &Path

Per-session XDG_RUNTIME_DIR, holding the Wayland socket and any supporting sockets like pipewire.
Source§

impl Default for MutterCompositor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for MutterCompositor

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more