Skip to main content

SandboxSession

Struct SandboxSession 

Source
pub struct SandboxSession { /* private fields */ }
Expand description

A Client bound to one sandbox session id – obtained from Client::with_sandbox. Holds a cheap clone of the underlying Client (see Client’s own note on cloning), so it is Clone and can outlive the borrow that produced it.

Implementations§

Source§

impl SandboxSession

Source

pub fn id(&self) -> &str

The bound sandbox session id.

Source

pub fn client(&self) -> &Client

The underlying Client, for the handful of calls not scoped to a single session (e.g. Client::list_sandboxes).

Source

pub async fn exec( &self, command: &str, options: ExecOptions, ) -> Result<ExecResult, BoxxkiteError>

Source

pub async fn http_request( &self, method: &str, url: &str, options: HttpRequestOptions, ) -> Result<HttpRequestResult, BoxxkiteError>

Source

pub async fn file_create( &self, path: &str, content: &str, options: FileOptions, ) -> Result<FileCreateResult, BoxxkiteError>

Source

pub async fn view( &self, path: &str, options: ViewOptions, ) -> Result<ViewResult, BoxxkiteError>

Source

pub async fn str_replace( &self, path: &str, old_str: &str, new_str: &str, options: StrReplaceOptions, ) -> Result<StrReplaceResult, BoxxkiteError>

Source

pub async fn ls(&self, options: LsOptions) -> Result<LsResult, BoxxkiteError>

Source

pub async fn glob( &self, pattern: &str, options: GlobOptions, ) -> Result<GlobResult, BoxxkiteError>

Source

pub async fn grep( &self, pattern: &str, options: GrepOptions, ) -> Result<GrepResult, BoxxkiteError>

Source

pub async fn get_log( &self, options: GetLogOptions, ) -> Result<AuditLogResponse, BoxxkiteError>

Source

pub fn watch( &self, ) -> Pin<Box<dyn Stream<Item = Result<AuditLogEntry, BoxxkiteError>> + Send + 'static>>

Source

pub async fn start_process( &self, command: &str, options: StartProcessOptions, ) -> Result<ProcessStartResult, BoxxkiteError>

Source

pub async fn list_processes(&self) -> Result<ProcessListResult, BoxxkiteError>

Source

pub async fn get_process_output( &self, process_id: &str, since_offset: i64, ) -> Result<ProcessOutputResult, BoxxkiteError>

Source

pub async fn send_process_input( &self, process_id: &str, data: &str, ) -> Result<ProcessInputResult, BoxxkiteError>

Source

pub async fn stop_process( &self, process_id: &str, ) -> Result<ProcessStopResult, BoxxkiteError>

Source

pub async fn takeover(&self) -> Result<TakeoverStream, BoxxkiteError>

Source

pub async fn desktop_takeover(&self) -> Result<DesktopStream, BoxxkiteError>

Source

pub async fn create_preview_url( &self, port: u16, ttl_seconds: Option<u32>, ) -> Result<PreviewUrl, BoxxkiteError>

Source

pub async fn revoke_preview_url( &self, port: u16, token_id: &str, ) -> Result<PreviewRevokeResult, BoxxkiteError>

Source

pub async fn lsp_start( &self, language: &str, ) -> Result<LspStartResult, BoxxkiteError>

Source

pub async fn lsp_open( &self, lsp_id: &str, path: &str, content: &str, ) -> Result<LspOpenResult, BoxxkiteError>

Source

pub async fn lsp_completion( &self, lsp_id: &str, path: &str, line: u32, character: u32, ) -> Result<LspCompletionResult, BoxxkiteError>

Source

pub async fn lsp_stop( &self, lsp_id: &str, ) -> Result<LspStopResult, BoxxkiteError>

Trait Implementations§

Source§

impl Clone for SandboxSession

Source§

fn clone(&self) -> Self

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 Debug for SandboxSession

Source§

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

Formats the value using the given formatter. Read more

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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