Skip to main content

Client

Struct Client 

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

The Client is used for all interaction with Control Tower or Edge Enforcer instances. Use one of the login functions to create an instance.

Implementations§

Source§

impl Client

Source

pub fn builder() -> ClientBuilder

Create a Client builder.

Source

pub async fn token_is_expired(&self) -> bool

Returns true if the token has expired.

Source

pub async fn token_expires(&self) -> DateTime<Utc>

Source

pub async fn jwt_svid(&self) -> Option<String>

Returns the JWT SVID if exists.

Source

pub async fn x509_svid(&self) -> Option<X509SVID>

Source

pub async fn bearer_token(&self) -> String

Returns the login bearer token.

Source

pub async fn get_json<T: DeserializeOwned>( &self, path: &str, query_params: Option<&[(&str, &str)]>, ) -> Result<T>

GET a json payload from the REST API.

Source

pub async fn get_bytes( &self, path: &str, query_params: Option<&[(&str, &str)]>, ) -> Result<Bytes>

GET a bytes payload from the REST API.

Source

pub async fn post_json(&self, path: &str, data: &Value) -> Result<Value>

POST arbitrary JSON to a path.

§Panics

never.

Source

pub async fn put<T: Into<Body> + Debug>( &self, path: &str, content_type: &str, data: T, ) -> Result<()>

PUT arbitrary data to a path.

Source

pub async fn put_json(&self, path: &str, data: &Value) -> Result<Value>

PUT arbitrary JSON to a path.

§Errors

crate::error::Error

Source

pub async fn volga_open_producer( &self, producer_name: &str, topic: &str, on_no_exists: OnNoExists, ) -> Result<Producer>

Open a volga producer on a topic.

§Errors

crate::error::Error

Source

pub async fn volga_open_child_site_producer( &self, producer_name: &str, topic: &str, site: &str, on_no_exists: OnNoExists, ) -> Result<Producer>

Open a volga NAT producer on a topic in a site.

§Errors

crate::error::Error

Source

pub async fn volga_open_parent_site_producer( &self, producer_name: &str, topic: &str, on_no_exists: OnNoExists, ) -> Result<Producer>

Open a volga producer on a topic in the parent site.

§Errors

crate::error::Error

Source

pub async fn volga_open_consumer( &self, consumer_name: &str, topic: &str, options: Options<'_>, ) -> Result<Consumer>

Creates and opens a Volga consumer.

§Errors

crate::error::Error

Source

pub async fn volga_open_child_site_consumer( &self, consumer_name: &str, topic: &str, site: &str, options: Options<'_>, ) -> Result<Consumer>

Creates and opens a Volga consumer on a child site.

§Errors

crate::error::Error

Source

pub async fn volga_open_parent_site_consumer( &self, consumer_name: &str, topic: &str, options: Options<'_>, ) -> Result<Consumer>

Creates and opens a Volga consumer on the parent site.

§Errors

crate::error::Error

Source

pub async fn volga_query_topic(&self, query: Query) -> Result<QueryStream>

Opens a query stream.

§Errors

crate::error::Error

Source

pub async fn connect( &self, application: &str, service_instance: &str, site: &str, protocol: Protocol, port: u16, ip_address: Option<IpAddr>, ) -> Result<Connection>

Setup a connection to a remote container.

§Errors

crate::error::Error

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

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 Client

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