Struct MutterCompositor 

pub struct MutterCompositor { /* private fields */ }

Headless mutter instance.

Implementations

impl MutterCompositor

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.

pub fn with_gsettings(self, config: GSettingsConfig) -> Self

Set the per-session GSettings isolation config (see waydriver::gsettings). Defaults to isolated with no seeded entries. When isolated, start writes a private keyfile (seeded with org.gnome.mutter experimental-features plus config.initial) and points mutter at it, so fractional scales work and the host’s dconf is neither read nor written. Pass isolated: false to run mutter against the host’s GSettings instead.

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

Returns the shared Arc<MutterState> for passing to sibling backends, or None when called outside the started window.

None is returned when:

• start() has not yet completed (or returned an error), or
• stop() has been called and dropped the state.

Callers that have just awaited start()? know the state is present — expect() or ?-with-typed-error is appropriate there. Returning Option instead of panicking keeps the API honest about the lifecycle and lets callers detect “stopped” without first matching on a panic.

Trait Implementations

impl CompositorRuntime for MutterCompositor

fn start<'life0, 'life1, 'async_trait>( &'life0 mut self, resolution: Option<&'life1 str>, scale: Option<f64>, ) -> 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.

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.

fn id(&self) -> &str

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

fn wayland_display(&self) -> &str

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

fn runtime_dir(&self) -> &Path

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

impl Default for MutterCompositor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for MutterCompositor

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.