Skip to main content

CommandsClient

Struct CommandsClient 

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

High-level client for invoking commands on Alien deployments.

Implementations§

Source§

impl CommandsClient

Source

pub fn new(manager_url: &str, deployment_id: &str, token: &str) -> Self

Create a new commands client with default config.

Source

pub fn with_config( manager_url: &str, deployment_id: &str, token: &str, config: CommandsClientConfig, ) -> Self

Create a new commands client with custom config.

Source

pub fn with_http_client( manager_url: &str, deployment_id: &str, http_client: Client, config: CommandsClientConfig, ) -> Self

Build a client over a caller-supplied HTTP client, reusing the headers it already carries (the auth header, and the workspace header used in platform mode). with_config builds a token-only client and can’t add those.

Source

pub async fn invoke<P: Serialize, R: DeserializeOwned>( &self, command: &str, params: P, ) -> Result<R, CommandError>

Invoke a command and wait for the result.

Sends params inline, polls for completion, and decodes the response.

Source

pub async fn invoke_with_options<P: Serialize, R: DeserializeOwned>( &self, command: &str, params: P, options: Option<InvokeOptions>, ) -> Result<R, CommandError>

Invoke a command with options and wait for the result.

Source

pub async fn create<P: Serialize>( &self, command: &str, params: P, options: Option<&InvokeOptions>, ) -> Result<String, CommandError>

Create a command without waiting for the result. Returns the command ID.

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> 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: 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: 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, 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