Struct KomodoClient

pub struct KomodoClient { /* private fields */ }

Client to interface with Komodo

Implementations

impl KomodoClient

pub fn subscribe_to_updates( &self, ) -> Result<(Receiver<UpdateWsMessage>, CancellationToken)>

Subscribes to the Komodo Core update websocket, and forwards the updates over a channel. Handles reconnection internally.

let (mut rx, _) = komodo.subscribe_to_updates()?;
loop {
  let update = match rx.recv().await {
    Ok(msg) => msg,
    Err(e) => {
      error!("🚨 recv error | {e:?}");
      break;
    }
  };
  // Handle the update
  info!("Got update: {update:?}");
}

impl KomodoClient

pub async fn auth<T>(&self, request: T) -> Result<T::Response>

where T: Serialize + KomodoAuthRequest, T::Response: DeserializeOwned,

pub async fn user<T>(&self, request: T) -> Result<T::Response>

where T: Serialize + KomodoUserRequest, T::Response: DeserializeOwned,

pub async fn read<T>(&self, request: T) -> Result<T::Response>

where T: Serialize + KomodoReadRequest, T::Response: DeserializeOwned,

pub async fn write<T>(&self, request: T) -> Result<T::Response>

where T: Serialize + KomodoWriteRequest, T::Response: DeserializeOwned,

pub async fn execute<T>(&self, request: T) -> Result<T::Response>

where T: Serialize + KomodoExecuteRequest, T::Response: DeserializeOwned,

impl KomodoClient

pub fn new( address: impl Into<String>, key: impl Into<String>, secret: impl Into<String>, ) -> KomodoClient

Initializes KomodoClient, including a health check.

pub fn new_from_env() -> Result<KomodoClient>

Initializes KomodoClient from environment: KomodoEnv

pub async fn with_healthcheck(self) -> Result<Self>

Add a healthcheck in the initialization pipeline:

let komodo = KomodoClient::new_from_env()?
  .with_healthcheck().await?;

pub async fn core_version(&self) -> Result<String>

Get the Core version.

pub async fn health_check(&self) -> Result<()>

Send a health check.

pub fn set_reqwest(self, reqwest: Client) -> Self

Use a custom reqwest client.

pub async fn poll_update_until_complete( &self, update_id: impl Into<String>, ) -> Result<Update>

Poll an Update (returned by the execute calls) until the UpdateStatus is Complete, and then return it.

Trait Implementations

impl Clone for KomodoClient

fn clone(&self) -> KomodoClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.