Skip to main content

SessionRpcShell

Struct SessionRpcShell 

Source
pub struct SessionRpcShell<'a> { /* private fields */ }
Expand description

session.shell.* RPCs.

Implementations§

Source§

impl<'a> SessionRpcShell<'a>

Source

pub async fn exec( &self, params: ShellExecRequest, ) -> Result<ShellExecResult, Error>

Starts a shell command and streams output through session notifications.

Wire method: session.shell.exec.

§Parameters
  • params - Shell command to run, with optional working directory and timeout in milliseconds.
§Returns

Identifier of the spawned process, used to correlate streamed output and exit notifications.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Source

pub async fn kill( &self, params: ShellKillRequest, ) -> Result<ShellKillResult, Error>

Sends a signal to a shell process previously started via “shell.exec”.

Wire method: session.shell.kill.

§Parameters
  • params - Identifier of a process previously returned by “shell.exec” and the signal to send.
§Returns

Indicates whether the signal was delivered; false if the process was unknown or already exited.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Trait Implementations§

Source§

impl<'a> Clone for SessionRpcShell<'a>

Source§

fn clone(&self) -> SessionRpcShell<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for SessionRpcShell<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for SessionRpcShell<'a>

§

impl<'a> !RefUnwindSafe for SessionRpcShell<'a>

§

impl<'a> Send for SessionRpcShell<'a>

§

impl<'a> Sync for SessionRpcShell<'a>

§

impl<'a> Unpin for SessionRpcShell<'a>

§

impl<'a> UnsafeUnpin for SessionRpcShell<'a>

§

impl<'a> !UnwindSafe for SessionRpcShell<'a>

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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