Struct ZoneRequest 

pub struct ZoneRequest {
    pub name: String,
    pub hint: ZoneHint,
    pub label: String,
    pub preferred_height: u16,
    pub preferred_width: u16,
    pub min_terminal_width: u16,
    pub order: u8,
}

A plugin’s request to create or own a zone.

Plugins submit requests during registration. The host evaluates each request and either grants a ZoneId or denies it.

Fields

name: String

Namespaced identifier: "{plugin_id}.{local_name}".

hint: ZoneHint

Where the plugin wants the zone.

label: String

Display label (for tabs, panel headers).

preferred_height: u16

Preferred height in lines (0 = fill available). Ignored for tabs.

preferred_width: u16

Preferred width in columns (0 = fill available). Ignored for tabs.

min_terminal_width: u16

Minimum terminal width for this zone to appear (0 = always).

order: u8

Display order within the zone hint (lower = first).

Implementations

impl ZoneRequest

pub fn tab(name: impl Into<String>, label: impl Into<String>) -> Self

Creates a tab zone request.

pub fn sidebar(name: impl Into<String>, label: impl Into<String>) -> Self

Creates a sidebar panel zone request.

pub fn overlay( name: impl Into<String>, label: impl Into<String>, width: u16, height: u16, ) -> Self

Creates a floating overlay zone request.

pub fn with_order(self, order: u8) -> Self

Sets the display order.

pub fn with_min_width(self, width: u16) -> Self

Sets the minimum terminal width.

Trait Implementations

impl Clone for ZoneRequest

fn clone(&self) -> ZoneRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZoneRequest

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

Formats the value using the given formatter.