Skip to main content

Client

Struct Client 

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

A connection to the Sessions service. Cloning is cheap and shares the connection.

Implementations§

Source§

impl Client

Source

pub async fn new(o: Options) -> Result<Client>

Connects to the sandbox plane (lazily: the connection is made on the first call).

Source

pub fn from_channel( channel: Channel, ts: SharedTokenSource, instance: impl Into<String>, ) -> Client

Builds a client on an existing channel. instance may be empty if only full resource names are used.

Source

pub fn raw(&self) -> SessionsClient<Channel>

The generated gRPC client, for calls this crate doesn’t wrap. It covers only the SDK’s subset of the Sessions API. Authorize each request with Client::request.

Source

pub fn instance(&self) -> String

The resource name “instances/{id}” used as the parent of sessions.

Source

pub fn token_source(&self) -> SharedTokenSource

The token source the client authorizes calls with.

Source

pub async fn request<T>(&self, msg: T) -> Result<Request<T>>

Wraps a message in a request carrying the bearer token.

Source§

impl Client

Source

pub async fn exec( &self, name: &str, argv: &[String], o: ExecOptions<'_>, ) -> Result<ExecResult>

Runs argv in the session (no shell; use Client::shell for that). A parked session is resumed by the plane first. Exec is refused while a shell attach holds the guest (see is_guest_held). A non-zero exit is reported in ExecResult, not as an error. If the connection fails once the command may have started, the error is Error::OutcomeUnknown with the transport error as its cause.

Source

pub async fn output( &self, name: &str, argv: &[String], o: ExecOptions<'_>, ) -> Result<Vec<u8>>

Runs argv and returns its stdout, or Error::Exit on a non-zero exit or a timeout.

Source

pub async fn shell( &self, name: &str, script: &str, o: ExecOptions<'_>, args: &[String], ) -> Result<Vec<u8>>

Runs script with sh -c; args become $1, $2, …

Source§

impl Client

Source

pub async fn write_file( &self, name: &str, path: &str, data: Vec<u8>, mode: u32, ) -> Result<()>

Atomically replaces path (creating parent directories) with data, with permission bits mode. It refuses an empty path and an existing directory (exit code 21, as an Error::Exit).

Source§

impl Client

Source

pub async fn complete_first_attach(&self, name: &str) -> Result<()>

Completes a new workspace session’s first attach, which the plane requires before it allows Exec (until then Exec fails with FailedPrecondition “attach with a shell first to upload the workspace”).

It opens one AttachSession stream with a shell, and if the plane reports workspace_pending, uploads an empty tree: a single FULL_TAR chunk holding an empty tar archive (gzip’d when the plane offers GZIP). It waits for WorkspaceReady and then detaches by canceling the stream. A session that isn’t pending is left as it is. It gives up after FIRST_ATTACH_TIMEOUT (an Error::Timeout with op “start”).

Source§

impl Client

Source

pub async fn create(&self, s: Session) -> Result<Session>

Creates a session in the client’s instance.

Source

pub async fn get(&self, name: &str) -> Result<Session>

Fetches a session by full resource name.

Source

pub async fn list(&self, o: &ListOptions) -> Result<Vec<Session>>

Every session in the instance, following page tokens.

Source

pub async fn resolve(&self, reference: &str) -> Result<Session>

Finds a session the way chainctl’s SESSION argument does: a full resource name, a short ID, or a display name (“quiet-harbor”, “app/quiet-harbor”, “acme/app/quiet-harbor”). No match is Error::NotFound (what “session”); several are Error::Ambiguous.

Source

pub async fn delete(&self, name: &str) -> Result<()>

Tears down the guest and discards its snapshot (or removes a reaped tombstone).

Source

pub async fn update(&self, s: Session, paths: &[&str]) -> Result<Session>

Applies a field-masked update, e.g. paths “display_name”.

Source

pub async fn park(&self, name: &str) -> Result<Session>

Asks the plane to snapshot and stop the VM (“Park now” in the menu).

Source

pub async fn heartbeat(&self, name: &str, hold_for: Duration) -> Result<Session>

Marks the session in use; a non-zero hold_for keeps it running that long after detach (--keep 8h).

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnsafeUnpin for Client

§

impl !UnwindSafe for Client

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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 = 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more