Struct ServerPty Copy item path

impl ServerPty

pub fn new() -> Result<Self, Error>

Creates a new instance of the Pty which must later be spawned.

pub async fn spawn( self, command: Option<&CStr>, environ: Option<&[&CStr]>, ) -> Result<ShellProcess, Error>

Spawns the Pty.

If no command is provided the default /boot/bin/sh will be used.

After calling this method the user must call resize to give the process a valid window size before it will respond.

The launched process will close when the Pty is dropped so you do not need to explicitly close it.

pub async fn spawn_with_argv( self, command: &CStr, argv: &[&CStr], environ: Option<&[&CStr]>, ) -> Result<ShellProcess, Error>

pub fn try_clone_fd(&self) -> Result<File, Error>

Attempts to clone the server side of the file descriptor.

pub async fn resize(&self, window_size: WindowSize) -> Result<(), Error>

Sends a message to the shell that the window has been resized.

pub async fn open_client( &self, server_end: ServerEnd<DeviceMarker>, ) -> Result<(), Error>

Open a client Pty device. server_end should be a handle to one endpoint of a channel that (on success) will become an open connection to the newly created device.

Trait Implementations§

impl Clone for ServerPty

fn clone(&self) -> ServerPty

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

impl !UnwindSafe for ServerPty

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

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

Performs copy-assignment from self to dst. Read more

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoAny for T
where T: 'static + Send + Sync,

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

Cast the given object into a dyn std::any::Any.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more