Skip to main content

TerminalState

Enum TerminalState 

Source
pub enum TerminalState {
    Created,
    Running,
    ShuttingDown,
    Closed,
}
Expand description

STATE MACHINE: TerminalInstance

Tracks the lifecycle of a PTY-backed terminal instance.

State Diagram:

Created ──────► Running ──────► ShuttingDown ──────► Closed │ ▲ │ (process exit, │ │ read error) │ └────────────────────────────────────┘

Transitions: Created -> Running (start signal sent via start_sender channel) Running -> ShuttingDown (shutdown_signal flag set to true) Running -> Closed (PTY process exits, reader thread detects EOF) ShuttingDown -> Closed (reader thread sees shutdown flag, exits loop)

Concurrency Invariant: Terminal I/O uses std::sync::Mutex (not tokio) because PTY operations are synchronous. The reader thread runs on a dedicated OS thread (not tokio task). ShutdownSignal uses AtomicBool for lock-free cross-thread signaling. State transitions should be synchronized through the TerminalManager’s terminals Mutex.

Interruption Table: ┌──────────────┬──────────────────────────────────────────────────────────┐ │ State │ What happens on crash/error │ ├──────────────┼──────────────────────────────────────────────────────────┤ │ Created │ PTY allocated but reader waiting for start signal. │ │ │ If app crashes: PTY master handle dropped, slave exits. │ │ │ start_sender channel dropped, reader thread unblocks │ │ │ and exits (recv() returns Err). │ ├──────────────┼──────────────────────────────────────────────────────────┤ │ Running │ Reader thread actively reading PTY output. │ │ │ If app crashes: PTY handles dropped, OS cleans up. │ │ │ If shell process exits: reader gets EOF, -> Closed. │ │ │ If reader thread panics: JoinHandle::join returns Err. │ │ │ Writer can still try to write (will get error). │ ├──────────────┼──────────────────────────────────────────────────────────┤ │ ShuttingDown │ Shutdown flag set. Reader thread checking flag each │ │ │ iteration. May take up to one read timeout to notice. │ │ │ If reader hangs on blocking read: may not shut down │ │ │ gracefully. Consider: close PTY master to force EOF. │ ├──────────────┼──────────────────────────────────────────────────────────┤ │ Closed │ Reader thread joined. PTY resources released. │ │ │ Terminal entry removed from TerminalManager map. │ └──────────────┴──────────────────────────────────────────────────────────┘

Variants§

§

Created

§

Running

§

ShuttingDown

§

Closed

Trait Implementations§

Source§

impl Clone for TerminalState

Source§

fn clone(&self) -> TerminalState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TerminalState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for TerminalState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for TerminalState

Source§

impl Eq for TerminalState

Source§

impl StructuralPartialEq for TerminalState

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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 + Send + Sync>

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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
Source§

impl<T> UserEvent for T
where T: Debug + Clone + Send + 'static,