Struct TermLinux 

pub struct TermLinux { /* private fields */ }

Available on crate features linux and term only.

🮖 🐧 Linux terminal frontend.

---

^{📍 sys/os/term::TermLinux}

^{📦 size_of::<TermLinux>() == 44 bytes / 352 bits #️⃣ #[cfg(not(feature = “event”))]}

^{📦 size_of::<TermLinux>() == 372 bytes / 2976 bits #️⃣ #[cfg(feature = “event”)] #[cfg(target_pointer_width = “32”)]}

^{📦 size_of::<TermLinux>() == 392 bytes / 3136 bits #️⃣ #[cfg(feature = “event”)] #[cfg(target_pointer_width = “64”)]}

---

Owns terminal input parsing, scoped session control, cached terminal and runtime capabilities, and the last known terminal size over the lower-level Linux terminal helpers.

Implementations

impl TermLinux

Core frontend control

pub fn open() -> LinuxResult<Self>

Opens a Linux terminal frontend.

This does not enter raw mode and does not install terminal cleanup guards. Session discipline belongs to the future terminal session layer.

pub fn session( &mut self, mode: TermMode, ) -> LinuxResult<TermSession<TermLinuxRestore>>

Enters a scoped terminal session.

Applies the requested terminal mode changes and returns a guard that restores the changed state when dropped.

The requested mode is translated by the backend restore payload, which records only the changes that must be undone on drop.

Only successfully applied changes are registered for restoration. This makes partial setup failures safe: if entering a later mode fails, earlier changes are still undone as the restore payload is dropped.

The returned guard does not borrow self, so the terminal frontend can continue to be used while the session is active.

pub fn session_raw(&mut self) -> LinuxResult<TermSession<TermLinuxRestore>>

Enters a scoped raw terminal session.

This is a convenience wrapper around session with TermMode::raw.

pub fn print(&mut self, bytes: &[u8]) -> LinuxResult<()>

Writes bytes to stdout.

pub const fn size(&self) -> Option<TermSize>

Returns the last known terminal size.

pub fn refresh_size(&mut self) -> LinuxResult<Option<TermSize>>

Refreshes and returns the terminal size.

impl TermLinux

Capabilities

pub const fn term_capabilities(&self) -> TermCaps

Returns the last known terminal protocol capabilities.

pub const fn run_capabilities(&self) -> RunCap

Returns the last known runtime capabilities.

pub fn probe_term_capabilities(&mut self) -> LinuxResult<TermCaps>

Available on crate features event and time only.

Probes terminal protocol capabilities exposed by the current terminal endpoint.

When running inside a terminal multiplexer such as tmux, this probes the multiplexer pseudo-terminal, not necessarily the outer terminal emulator.

Features

Available with the time feature, because probing uses bounded waits for terminal replies.

pub fn probe_run_capabilities(&mut self) -> LinuxResult<RunCap>

Available on crate features event and time only.

Probes terminal capabilities, refreshes size, and recomputes runtime capabilities.

Features

Available with the time feature, because terminal probing uses bounded waits.

pub fn refresh_run_capabilities(&mut self) -> LinuxResult<RunCap>

Refreshes runtime capabilities from cached terminal capabilities and current size.

impl TermLinux

Event polling

pub fn poll_event(&mut self) -> LinuxResult<Option<EventKind>>

Available on crate feature event only.

Polls for one terminal event using the default low-latency policy.

This is non-blocking. It drains ready bytes and resolves a pending lone Escape when no more bytes are immediately available.

pub fn poll_event_with( &mut self, policy: TermPollPolicy, ) -> LinuxResult<Option<EventKind>>

Available on crate feature event only.

Polls for one terminal event using policy.

Features

With the time feature, this also supports TermPollPolicy::Timeout.

pub fn poll_event_pending(&mut self) -> LinuxResult<Option<EventKind>>

Available on crate feature event only.

Non-blocking. Preserves pending partial input sequences.

pub fn poll_event_timeout( &mut self, timeout: Duration, ) -> LinuxResult<Option<EventKind>>

Available on crate features event and time only.

Non-blocking. Resolves pending lone Escape after timeout.

This only waits when the parser is holding a pending ESC.

pub fn wait_event(&mut self) -> LinuxResult<EventKind>

Available on crate feature event only.

Blocks until a terminal event is available.

Buffered events are returned first. Newly read bytes are parsed through the semantic event queue, preserving the same construction and timestamping path used by non-blocking polling.

With time, a pending lone ESC is briefly disambiguated before being emitted as an Escape event.

impl TermLinux

Signal handling

pub fn listen_signals(&mut self, controls: AppControlSet)

Available on crate feature event only.

Registers Linux signals used by this terminal event source.

This enables application control notices from controls and terminal resize notices from SIGWINCH. Pending notices are drained into this backend’s event queue as EventKind::Control and EventWindow::Resized.

This installs process-wide signal handlers. Registering another handler for the same Linux signals may replace this path.

pub fn listen_app_controls(&mut self, controls: AppControlSet)

Available on crate feature event only.

Registers application control notices as terminal events.

This installs process-wide Linux signal handlers for the corresponding controls. Pending notices are drained into this backend’s event queue as EventKind::Control.

Registering another handler for the same Linux signals may replace this path.

pub fn listen_resize(&mut self)

Available on crate feature event only.

Registers terminal resize notices as window resize events.

This installs a process-wide SIGWINCH handler. Pending resize notices are drained into this backend’s event queue as EventWindow::Resized.

Registering another handler for SIGWINCH may replace this path.

Trait Implementations

impl Clone for TermLinux

fn clone(&self) -> TermLinux

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TermLinux

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

Formats the value using the given formatter.

impl RunService for TermLinux

fn run_capabilities(&self) -> RunCap

Returns the currently known service capabilities.

fn run_version(&self) -> VersionFull<'_>

Returns service version metadata.

impl RunServiceProbe for TermLinux

Available on crate features event and time only.

type Error = LinuxError

Error returned while refreshing service capabilities.

fn run_capabilities_refresh(&mut self) -> Result<RunCap, Self::Error>

Refreshes and returns the currently known service capabilities.

impl TermBackend for TermLinux

type Error = LinuxError

Backend error type.

type Session = TermSession<TermLinuxRestore>

Guard type returned when entering a terminal session.

fn open() -> LinuxResult<Self>

Opens a terminal backend.

fn session(&mut self, mode: TermMode) -> LinuxResult<Self::Session>

Enters a scoped terminal session.

fn print(&mut self, bytes: &[u8]) -> LinuxResult<()>

Writes bytes to the terminal output stream.

fn size(&self) -> Option<TermSize>

Returns the last known terminal size.

fn refresh_size(&mut self) -> LinuxResult<Option<TermSize>>

Refreshes and returns the terminal size.

fn term_capabilities(&self) -> TermCaps

Returns the last known terminal protocol capabilities.

fn probe_term_capabilities(&mut self) -> LinuxResult<TermCaps>

Probes terminal protocol capabilities.

fn poll_event_with( &mut self, policy: TermPollPolicy, ) -> LinuxResult<Option<EventKind>>

Available on crate feature event only.

Polls for one terminal event using policy.

fn session_raw(&mut self) -> Result<Self::Session, Self::Error>

Enters a scoped raw terminal session.

fn poll_event(&mut self) -> Result<Option<EventKind>, Self::Error>

Available on crate feature event only.

Polls for one terminal event using the default immediate policy.