Skip to main content

PaneGrid

Struct PaneGrid 

Source
pub struct PaneGrid { /* private fields */ }
Expand description

Live grid + cursor + the parser that feeds them. Owns mutable state, so callers wrap it in Mutex (the InProcess does this since multiple PTY-reader threads + the RPC dispatch thread all race for it).

Implementations§

Source§

impl PaneGrid

Source

pub fn modes(&self) -> ModeSet

Every terminal mode this pane is in, taken at ONE instant.

This is how a client reads a mode under docs/SHUKEN.md — from the authority, never from a parser of its own. Today mado reads bracketed_paste from its OWN Terminal, which is correct only because mado still parses every byte; it becomes a live bug the instant this grid is authoritative, and it is a paste-sanitisation decision, not a cosmetic one.

Returned as a whole ModeSet rather than one getter per mode so a client cannot mix modes from two different instants.

Source

pub fn snapshot(&self) -> PaneSnapshot

Source

pub fn title(&self) -> Option<&str>

Current window title (OSC 0 / 2). None until the first title set; cleared on RIS.

Source

pub fn stamp_yurai(&mut self, y: Yurai) -> bool

Stamp the owning pane’s provenance so every block this grid mints records WHO ran it. Write-once; returns true if this call took effect.

Provenance enters through the grid deliberately. Under shuken (docs/SHUKEN.md) PaneGrid is the sole VT authority — it is the one place that sees the byte stream and mints blocks from it — so attribution belongs at the same seam as the authority. A second, parallel path that attributed blocks anywhere else would be exactly the duplicated-state split shuken exists to forbid.

Source

pub fn yurai(&self) -> &Yurai

Provenance every block from this grid carries.

Source

pub fn cursor_keys_mode(&self) -> bool

DECCKM (DEC mode 1) cursor-keys application mode.

Consumers translating host keystrokes to PTY bytes (mado’s keybind::madori_key_to_pty_bytes, any future tear-client renderer) read this to encode Up/Down/Right/Left as ESC O A/B/C/D (true) or ESC [ A/B/C/D (false).

Source

pub fn scrollback_len(&self) -> usize

Number of scrollback rows that have rolled off the primary screen. Useful for tests + UI affordances.

Source

pub fn resize(&mut self, cols: usize, rows: usize)

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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more