Skip to main content

ControlPlaneClient

Struct ControlPlaneClient 

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

Calls the control-plane API on behalf of the CLI.

Cheap to clone (reqwest::Client is an Arc inside). Holds the bearer token the API requires; None is only useful against a --no-auth control plane.

Implementations§

Source§

impl ControlPlaneClient

Source

pub fn new(base_url: impl Into<String>) -> Self

Target the control plane at base_url (e.g. http://127.0.0.1:9090).

A trailing slash is trimmed, so a pasted URL and a typed one behave the same.

Source

pub fn with_token(self, token: impl Into<String>) -> Self

Present this bearer token on every request.

Source

pub fn with_optional_token(self, token: Option<impl Into<String>>) -> Self

Present token if there is one — the Option-shaped form of with_token, so a caller resolving a flag or an env var does not have to branch.

Source

pub fn base_url(&self) -> &str

The control plane this client talks to.

Source

pub async fn deploy( &self, config_toml: impl Into<String>, ) -> Result<DeployedAgent, ControlPlaneClientError>

Deploy an agent from raw, unexpanded config TOML.

Deliberately takes the text as it sits on disk: ${VAR} refs are the control plane’s to resolve, against its own environment and its allowlist. Expanding them here would put the operator’s secrets on the wire and require the deploying machine to hold them.

Source

pub async fn list( &self, filter: ListFilter, ) -> Result<Vec<DeployedAgent>, ControlPlaneClientError>

Deployed agents with their endpoint and current health.

ListFilter::Live hides agents that have been stopped; the control plane keeps their entries (their logs are still readable) but they are not part of what is running.

Source

pub async fn status( &self, id: &AgentId, ) -> Result<AgentStatus, ControlPlaneClientError>

One agent’s current health.

Source

pub async fn logs( &self, id: &AgentId, tail: Option<usize>, ) -> Result<AgentLogs, ControlPlaneClientError>

An agent’s captured output, oldest line first, limited to the last tail lines when given.

Source

pub async fn undeploy( &self, id: &AgentId, ) -> Result<(), ControlPlaneClientError>

Stop an agent and remove it from discovery.

Trait Implementations§

Source§

impl Clone for ControlPlaneClient

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 ControlPlaneClient

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> 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> 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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<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