Struct Consul

pub struct Consul { /* private fields */ }

Client used to talk to a Consul server. All calls to the key/value API are automatically prefixed with an arbitrary string that is constructed at client creation.

Implementations

impl Consul

pub async fn catalog_node_list( &self, last_index: Option<usize>, ) -> Result<WithIndex<Vec<Node>>>

The “list nodes” API call of the Catalog API

https://developer.hashicorp.com/consul/api-docs/catalog#list-nodes

pub async fn catalog_node( &self, host: &str, last_index: Option<usize>, ) -> Result<WithIndex<Option<CatalogNode>>>

The “retrieve map of services for a node” API call of the Catalog API

https://developer.hashicorp.com/consul/api-docs/catalog#retrieve-map-of-services-for-a-node

pub async fn catalog_service_list( &self, last_index: Option<usize>, ) -> Result<WithIndex<ServiceList>>

The “list services” API call of the Catalog api

https://developer.hashicorp.com/consul/api-docs/catalog#list-services

pub async fn catalog_service_nodes( &self, service: &str, last_index: Option<usize>, ) -> Result<WithIndex<Vec<ServiceNode>>>

The “list nodes for a service” API call of the Catalog api

https://developer.hashicorp.com/consul/api-docs/catalog#list-nodes-for-service

pub async fn health_service_instances( &self, service: &str, last_index: Option<usize>, ) -> Result<WithIndex<Vec<HealthServiceNode>>>

The “list service instances for a service” API call of the Health api

https://developer.hashicorp.com/consul/api-docs/health#list-service-instances-for-service

pub fn watch_all_service_health( &self, max_retry_interval: Duration, ) -> Receiver<AllServiceHealth>

Launches a background task that watches all services and the nodes that serve them, and make that info available in a tokio watch channel. The worker terminates when the channel is dropped.

impl Consul

pub async fn kv_get(&self, key: &str) -> Result<Option<Bytes>>

pub async fn kv_get_json<T: for<'de> Deserialize<'de>>( &self, key: &str, ) -> Result<Option<T>>

pub async fn kv_get_prefix( &self, key_prefix: &str, last_index: Option<usize>, ) -> Result<WithIndex<HashMap<String, Bytes>>>

pub async fn kv_put(&self, key: &str, bytes: Bytes) -> Result<()>

pub async fn kv_put_json<T: Serialize>( &self, key: &str, value: &T, ) -> Result<()>

pub async fn kv_delete(&self, key: &str) -> Result<()>

impl Consul

pub async fn create_session(&self, req: &SessionRequest) -> Result<String>

pub async fn acquire( &self, key: &str, bytes: Bytes, session: &str, ) -> Result<bool>

pub async fn release( &self, key: &str, bytes: Bytes, session: &str, ) -> Result<()>

impl Consul

pub fn new(config: Config, kv_prefix: &str) -> Result<Self>

Trait Implementations

impl Clone for Consul

fn clone(&self) -> Consul

Returns a copy of the value.

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

Performs copy-assignment from source.