Struct axiom_rs::client::Client

pub struct Client {
    pub datasets: Client,
    pub users: Client,
    /* private fields */
}

The client is the entrypoint of the whole SDK.

You can create it using Client::builder or Client::new.

Examples

use axiom_rs::{Client, Error};

fn main() -> Result<(), Error> {
    // Create a new client and get the token, url and (if necesary) org id
    // from the environment variables AXIOM_TOKEN, AXIOM_URL and AXIOM_ORG_ID.
    let client = Client::new()?;

    // Set all available options. Unset options fall back to environment
    // variables.
    let client = Client::builder()
        .with_token("my-token")
        .with_url("http://example.org")
        .with_org_id("my-org-id")
        .build()?;

    Ok(())
}

Fields

datasets: Client

users: Client

Implementations

impl Client

pub fn new() -> Result<Self>

Creates a new client. If you want to configure it, use Client::builder.

pub fn builder() -> Builder

Create a new client using a builder.

pub fn url(&self) -> String

Get the url (cloned).

pub async fn version(&self) -> String

Get client version.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.