Struct Terminal 

pub struct Terminal {
    pub dev_pts_root: DirEntryHandle,
    pub fscred: FsCred,
    pub id: u32,
    /* private fields */
}

State of a given terminal. This object handles both the main and the replica terminal.

Fields

dev_pts_root: DirEntryHandle

The root of the devpts fs responsible for this terminal.

fscred: FsCred

The owner of the terminal.

id: u32

The identifier of the terminal.

Implementations

impl Terminal

pub fn new( state: Arc<TtyState>, dev_pts_root: DirEntryHandle, fscred: FsCred, id: u32, ) -> Arc<Self>

pub fn to_owned(&self) -> Arc<Terminal>

pub fn set_termios(&self, termios: termios2)

Sets the terminal configuration.

pub fn flush(&self, is_main: bool, arg: u32) -> Result<(), Errno>

pub fn main_close(&self)

close implementation of the main side of the terminal.

pub fn main_open(&self)

Called when a new reference to the main side of this terminal is made.

pub fn main_wait_async( &self, waiter: &Waiter, events: FdEvents, handler: EventHandler, ) -> WaitCanceler

wait_async implementation of the main side of the terminal.

pub fn main_query_events(&self) -> FdEvents

query_events implementation of the main side of the terminal.

pub fn main_read(&self, data: &mut dyn OutputBuffer) -> Result<usize, Errno>

read implementation of the main side of the terminal.

pub fn main_write(&self, data: &mut dyn InputBuffer) -> Result<usize, Errno>

write implementation of the main side of the terminal.

pub fn replica_close(&self)

close implementation of the replica side of the terminal.

pub fn replica_open(&self)

Called when a new reference to the replica side of this terminal is made.

pub fn replica_wait_async( &self, waiter: &Waiter, events: FdEvents, handler: EventHandler, ) -> WaitCanceler

wait_async implementation of the replica side of the terminal.

pub fn replica_query_events(&self) -> FdEvents

query_events implementation of the replica side of the terminal.

pub fn replica_read(&self, data: &mut dyn OutputBuffer) -> Result<usize, Errno>

read implementation of the replica side of the terminal.

pub fn replica_write(&self, data: &mut dyn InputBuffer) -> Result<usize, Errno>

write implementation of the replica side of the terminal.

pub fn disassociate_controlling_session(&self)

Disassociates the controlling session from the terminal.

Clears the controlling session, clears controlling_terminal on all member thread groups in the session, and sends SIGHUP and SIGCONT to the foreground process group outside of any terminal locks.

pub fn disassociate_controlling_session_if( &self, expected_session: Option<&Pid>, side: Option<TerminalSide>, )

Disassociates the controlling session from the terminal if expected_session matches (or is None), clearing matching member controlling_terminal references and sending SIGHUP and SIGCONT to the foreground process group outside of any terminal locks.

pub fn send_signals(&self, signals: &[Signal])

Sends the specified signals to the foreground process group of this terminal.

The terminal state lock is held only to extract the foreground PID and is dropped before signal dispatch to prevent lock inversion with ThreadGroup locks.

pub fn device(&self) -> DeviceId

pub fn read<'a>(self: &'a Terminal) -> TerminalReadGuard<'a>

pub fn write<'a>(self: &'a Terminal) -> TerminalWriteGuard<'a>

Trait Implementations

impl Debug for Terminal

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

Formats the value using the given formatter.

impl Drop for Terminal

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.