Skip to main content

PtyAttachment

Struct PtyAttachment 

Source
pub struct PtyAttachment {
    pub initial_backlog: Vec<u8>,
    pub bytes_missed: u64,
    /* private fields */
}
Expand description

Active attachment to a daemon-owned PTY session.

Owns the socket; the connection is in streaming mode and cannot be used for unrelated RPCs.

Fields§

§initial_backlog: Vec<u8>

Bytes received in the initial AttachPtySessionResponse (output the client missed before attach succeeded).

§bytes_missed: u64

Cumulative bytes dropped from the daemon’s ring buffer before this attach. Zero if the buffer never overflowed.

Implementations§

Source§

impl PtyAttachment

Source

pub fn attach( scope_hash: Option<&str>, session_id: &str, rows: u16, cols: u16, steal: bool, ) -> Result<Self, AttachError>

Open a fresh socket to the daemon and attach to session_id.

Source

pub fn attach_to( socket_path: &str, session_id: &str, rows: u16, cols: u16, steal: bool, ) -> Result<Self, AttachError>

Open a fresh socket at socket_path and attach to session_id.

Source

pub fn recv_frame(&mut self) -> Result<PtyStreamFrame, AttachError>

Block until the next stream frame arrives.

Source

pub fn recv_frame_with_timeout( &mut self, timeout: Duration, ) -> Result<Option<PtyStreamFrame>, AttachError>

Block until the next stream frame arrives, or until timeout elapses (returns Ok(None)). The underlying socket is put into nonblocking mode for the duration of the wait; callers should not interleave this with recv_frame.

Source

pub fn send_input(&mut self, bytes: &[u8]) -> Result<(), AttachError>

Send raw input bytes to the PTY.

Source

pub fn resize(&mut self, rows: u16, cols: u16) -> Result<(), AttachError>

Send a resize event.

Source

pub fn send_interrupt(&mut self) -> Result<(), AttachError>

Send an interrupt (Ctrl+C / SIGINT) to the child process group.

Source

pub fn detach(self) -> Result<(), AttachError>

Cleanly detach this attachment; the session keeps running.

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> 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, 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.