Lattice SDK Rust Library

The Lattice SDK Rust library provides convenient access to the Lattice SDK APIs from Rust.

Documentation

API reference documentation is available here.

Installation

Add this to your Cargo.toml:

[dependencies]
lattice_sdk = "0.1.0"

Or install via cargo:

cargo add lattice_sdk

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

use lattice_sdk::prelude::*;

#[tokio::main]
async fn main() {
    let config = ClientConfig {
        token: Some("<token>".to_string()),
        ..Default::default()
    };
    let client = LatticeClient::new(config).expect("Failed to build client");
    client
        .entities
        .long_poll_entity_events(
            &EntityEventRequest {
                session_token: "sessionToken".to_string(),
            },
            None,
        )
        .await;
}

Errors

When the API returns a non-success status code (4xx or 5xx response), an error will be returned.

match client.entities.long_poll_entity_events(None)?.await {
    Ok(response) => {
        println!("Success: {:?}", response);
    },
    Err(ApiError::HTTP { status, message }) => {
        println!("API Error {}: {:?}", status, message);
    },
    Err(e) => {
        println!("Other error: {:?}", e);
    }
}

Request Types

The SDK exports all request types as Rust structs. Simply import them from the crate to access them:

use lattice_sdk::prelude::{*};

let request = EntityOverride {
    ...
};

Advanced

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the max_retries method to configure this behavior.

let response = client.entities.long_poll_entity_events(
    Some(RequestOptions::new().max_retries(3))
)?.await;

Timeouts

The SDK defaults to a 30 second timeout. Use the timeout method to configure this behavior.

let response = client.entities.long_poll_entity_events(
    Some(RequestOptions::new().timeout_seconds(30))
)?.await;

Additional Headers

You can add custom headers to requests using RequestOptions.

let response = client.entities.long_poll_entity_events(
    Some(
        RequestOptions::new()
            .additional_header("X-Custom-Header", "custom-value")
            .additional_header("X-Another-Header", "another-value")
    )
)?
.await;

Additional Query String Parameters

You can add custom query parameters to requests using RequestOptions.

let response = client.entities.long_poll_entity_events(
    Some(
        RequestOptions::new()
            .additional_query_param("filter", "active")
            .additional_query_param("sort", "desc")
    )
)?
.await;