Skip to main content

AgentClient

Struct AgentClient 

Source
pub struct AgentClient { /* private fields */ }

Implementations§

Source§

impl AgentClient

Source

pub async fn connect( endpoint: &str, box_id: &str, ca_pem: &str, client_identity: &CertificateMaterial, ) -> Result<Self, AgentClientError>

Source

pub async fn connect_with_relay( endpoint: &str, box_id: &str, ca_pem: &str, client_identity: &CertificateMaterial, relay: Option<&RelayAccess>, ) -> Result<Self, AgentClientError>

Connect directly or carry the same mutual TLS connection through a relay.

Source

pub async fn connect_with_relay_route( endpoint: &str, box_id: &str, ca_pem: &str, client_identity: &CertificateMaterial, relay: Option<&RelayAccess>, route: &str, ) -> Result<Self, AgentClientError>

Source

pub async fn info(&mut self) -> Result<InfoResponse, AgentClientError>

Source

pub async fn ping(&mut self) -> Result<PingResponse, AgentClientError>

Source

pub async fn exec( &mut self, argv: Vec<String>, cwd: impl Into<String>, env: impl IntoIterator<Item = (String, String)>, user: impl Into<String>, ) -> Result<ExecResult, AgentClientError>

Source

pub async fn exec_pty( &mut self, argv: Vec<String>, cwd: impl Into<String>, env: impl IntoIterator<Item = (String, String)>, user: impl Into<String>, stdin: Vec<u8>, ) -> Result<ExecResult, AgentClientError>

Source

pub async fn exec_stream<S>( &mut self, requests: S, ) -> Result<Streaming<ExecEvent>, AgentClientError>
where S: IntoStreamingRequest<Message = ExecRequest>,

Source

pub async fn exec_pty_session( &mut self, argv: Vec<String>, cwd: impl Into<String>, env: impl IntoIterator<Item = (String, String)>, user: impl Into<String>, ) -> Result<ExecPtySession, AgentClientError>

Source

pub async fn exec_pty_session_with_size( &mut self, argv: Vec<String>, cwd: impl Into<String>, env: impl IntoIterator<Item = (String, String)>, user: impl Into<String>, terminal_rows: u32, terminal_cols: u32, ) -> Result<ExecPtySession, AgentClientError>

Source

pub async fn terminal_session( &mut self, request: ExecRequest, ) -> Result<ExecPtySession, AgentClientError>

Attach to an agent-owned terminal, creating it when its name is unused.

Source

pub async fn list_sessions( &mut self, ) -> Result<Vec<TerminalSession>, AgentClientError>

Source

pub async fn start_session( &mut self, request: ExecRequest, ) -> Result<TerminalSession, AgentClientError>

Source

pub async fn read_session( &mut self, name: impl Into<String>, ) -> Result<ReadSessionResponse, AgentClientError>

Source

pub async fn read_session_history( &mut self, name: impl Into<String>, ) -> Result<ReadSessionResponse, AgentClientError>

Source

pub async fn send_session( &mut self, name: impl Into<String>, text: String, keys: Vec<String>, ) -> Result<(), AgentClientError>

Source

pub async fn close_session( &mut self, name: impl Into<String>, ) -> Result<(), AgentClientError>

Source

pub async fn exec_with_mode( &mut self, argv: Vec<String>, cwd: impl Into<String>, env: impl IntoIterator<Item = (String, String)>, user: impl Into<String>, allocate_pty: bool, stdin: Vec<u8>, ) -> Result<ExecResult, AgentClientError>

Source

pub async fn forward_stream<S>( &mut self, requests: S, ) -> Result<Streaming<ForwardEvent>, AgentClientError>
where S: IntoStreamingRequest<Message = ForwardEvent>,

Source

pub async fn forward_tcp( &mut self, socket: TcpStream, host: impl Into<String>, port: u16, ) -> Result<(), AgentClientError>

Source

pub async fn put_file( &mut self, path: impl Into<String>, data: Vec<u8>, mode: u32, atomic_write: bool, ) -> Result<FileResult, AgentClientError>

Source

pub async fn get_file( &mut self, path: impl Into<String>, ) -> Result<Vec<u8>, AgentClientError>

Trait Implementations§

Source§

impl Clone for AgentClient

Source§

fn clone(&self) -> AgentClient

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

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

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

impl<L> LayerExt<L> for L

Source§

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.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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