Enum zellij_utils::plugin_api::generated_api::api::input_mode::InputMode

#[repr(i32)]
pub enum InputMode {
    Normal = 0,
    Locked = 1,
    Resize = 2,
    Pane = 3,
    Tab = 4,
    Scroll = 5,
    EnterSearch = 6,
    Search = 7,
    RenameTab = 8,
    RenamePane = 9,
    Session = 10,
    Move = 11,
    Prompt = 12,
    Tmux = 13,
}

Variants

Normal = 0

/ In Normal mode, input is always written to the terminal, except for the shortcuts leading / to other modes

Locked = 1

/ In Locked mode, input is always written to the terminal and all shortcuts are disabled / except the one leading back to normal mode

Resize = 2

/ Resize mode allows resizing the different existing panes.

Pane = 3

/ Pane mode allows creating and closing panes, as well as moving between them.

Tab = 4

/ Tab mode allows creating and closing tabs, as well as moving between them.

Scroll = 5

/ Scroll mode allows scrolling up and down within a pane.

EnterSearch = 6

/ EnterSearch mode allows for typing in the needle for a search in the scroll buffer of a pane.

Search = 7

/ Search mode allows for searching a term in a pane (superset of Scroll).

RenameTab = 8

/ RenameTab mode allows assigning a new name to a tab.

RenamePane = 9

/ RenamePane mode allows assigning a new name to a pane.

Session = 10

/ Session mode allows detaching sessions

Move = 11

/ Move mode allows moving the different existing panes within a tab

Prompt = 12

/ Prompt mode allows interacting with active prompts.

Tmux = 13

/ Tmux mode allows for basic tmux keybindings functionality

Implementations

impl InputMode

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of InputMode.

pub fn from_i32(value: i32) -> Option<InputMode>

Converts an i32 to a InputMode, or None if value is not a valid variant.

impl InputMode

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for InputMode

fn clone(&self) -> InputMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputMode

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

Formats the value using the given formatter.

impl Default for InputMode

fn default() -> InputMode

Returns the “default value” for a type.

impl From<InputMode> for i32

fn from(value: InputMode) -> i32

Converts to this type from the input type.

impl Hash for InputMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for InputMode

fn cmp(&self, other: &InputMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for InputMode

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for InputMode

fn partial_cmp(&self, other: &InputMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<InputMode> for ProtobufInputMode

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(input_mode: InputMode) -> Result<Self, &'static str>

Performs the conversion.

impl TryFrom<InputMode> for InputMode

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from( protobuf_input_mode: ProtobufInputMode ) -> Result<Self, &'static str>

Performs the conversion.

impl Copy for InputMode

impl Eq for InputMode

impl StructuralPartialEq for InputMode