Skip to main content

PluginSharedState

Struct PluginSharedState 

Source
pub struct PluginSharedState {
    pub cells: Vec<Cell>,
    pub cols: u16,
    pub rows: u16,
    pub cursor: (u16, u16),
    pub env: HashMap<String, String>,
    pub data: HashMap<String, String>,
    pub commands: Vec<ModalItem>,
}
Expand description

Shared state accessible to plugins

This wraps the protocol’s SharedState with a simpler interface for plugins. The protocol’s SharedState uses #[repr(C)] for IPC, while this one provides a high-level API for plugin development.

Fields§

§cells: Vec<Cell>

Terminal grid cells

§cols: u16

Grid width in columns

§rows: u16

Grid rows

§cursor: (u16, u16)

Current cursor position

§env: HashMap<String, String>

Environment variables

§data: HashMap<String, String>

Custom plugin-specific data storage

§commands: Vec<ModalItem>

Aggregated list of commands from all plugins

Implementations§

Source§

impl PluginSharedState

Source

pub fn new(cols: u16, rows: u16) -> Self

Create new shared state

Source

pub fn get_cell(&self, x: u16, y: u16) -> Option<Cell>

Get cell at position

Source

pub fn set_cell(&mut self, x: u16, y: u16, cell: Cell) -> bool

Set cell at position

Source

pub fn get_line(&self, y: u16) -> Option<String>

Get line of text

Trait Implementations§

Source§

impl Debug for PluginSharedState

Source§

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

Formats the value using the given formatter. 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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

Source§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The type for metadata in pointers and references to Self.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V