Trait river_layout_toolkit::Layout

pub trait Layout: 'static {
    type Error: StdError;

    const NAMESPACE: &'static str;

    // Required methods
    fn user_cmd(
        &mut self,
        cmd: String,
        tags: Option<u32>,
        output: &str
    ) -> Result<(), Self::Error>;
    fn generate_layout(
        &mut self,
        view_count: u32,
        usable_width: u32,
        usable_height: u32,
        tags: u32,
        output: &str
    ) -> Result<GeneratedLayout, Self::Error>;
}

This trait represents a layout generator implementation.

Required Associated Types

type Error: StdError

The error type of user_cmd and generate_layout functions. Use Infallible if you don’t need it.

Required Associated Constants

const NAMESPACE: &'static str

The namespace is used by the compositor to distinguish between layout generators. Two separate clients may not share a namespace. Otherwise, run will return Error::NamespaceInUse.

Required Methods

fn user_cmd( &mut self, cmd: String, tags: Option<u32>, output: &str ) -> Result<(), Self::Error>

This function is called whenever the user sends a command via riverctl send-layout-cmd.

Errors

An error returned from this function will be logged, but it will not terminate the application.

fn generate_layout( &mut self, view_count: u32, usable_width: u32, usable_height: u32, tags: u32, output: &str ) -> Result<GeneratedLayout, Self::Error>

This function is called whenever compositor requests a layout.

Errors

Returning an error from this fuction will cause run to terminate.

Implementors