Struct raystack::SkySparkClient

pub struct SkySparkClient { /* fields omitted */ }

A client for interacting with a SkySpark server.

Implementations

impl SkySparkClient

pub async fn new(
    project_api_url: Url,
    username: &str,
    password: &str,
    client_seed: ClientSeed
) -> Result<Self, NewSkySparkClientError>

Create a new SkySparkClient.

Example

use raystack::{ClientSeed, SkySparkClient};
use url::Url;
let timeout_in_seconds = 30;
let client_seed = ClientSeed::new(timeout_in_seconds).unwrap();
let url = Url::parse("https://skyspark.company.com/api/bigProject/").unwrap();
let mut client = SkySparkClient::new(url, "username", "p4ssw0rd", client_seed).await.unwrap();

If creating multiple SkySparkClients, the same ClientSeed should be used for each. For example:

use raystack::{ClientSeed, SkySparkClient};
use url::Url;
let client_seed = ClientSeed::new(30).unwrap();
let url1 = Url::parse("http://test.com/api/bigProject/").unwrap();
let client1 = SkySparkClient::new(url1, "name", "p4ssw0rd", client_seed.clone()).await.unwrap();
let url2 = Url::parse("http://test.com/api/smallProj/").unwrap();
let client2 = SkySparkClient::new(url2, "name", "p4ss", client_seed.clone()).await.unwrap();

We pass in the ClientSeed struct because the underlying crypto library recommends that an application should create a single random number generator and use it for all randomness generation. Additionally, the underlying HTTP library recommends using a single copy of its HTTP client. These two resources are wrapped by this ClientSeed struct.

pub fn project_name(&self) -> &str

Return the project name for this client.

pub fn project_api_url(&self) -> &Url

Return the project API url being used by this client.

impl SkySparkClient

pub async fn about(&mut self) -> Result<Grid, Error>

Returns a grid containing basic server information.

pub async fn formats(&mut self) -> Result<Grid, Error>

Returns a grid describing what MIME types are available.

pub async fn his_read(
    &mut self,
    id: &Ref,
    range: &HisReadRange
) -> Result<Grid, Error>

Returns a grid of history data for a single point.

pub async fn his_write_bool(
    &mut self,
    id: &Ref,
    his_data: &[(DateTime, bool)]
) -> Result<Grid, Error>

Writes boolean values to a single point.

pub async fn his_write_num(
    &mut self,
    id: &Ref,
    his_data: &[(DateTime, Number)]
) -> Result<Grid, Error>

Writes numeric values to a single point. unit must be a valid Haystack unit literal, such as L/s or celsius.

pub async fn his_write_str(
    &mut self,
    id: &Ref,
    his_data: &[(DateTime, String)]
) -> Result<Grid, Error>

Writes string values to a single point.

pub async fn utc_his_write_bool(
    &mut self,
    id: &Ref,
    time_zone_name: &str,
    his_data: &[(DateTime<Utc>, bool)]
) -> Result<Grid, Error>

Writes boolean values with UTC timestamps to a single point. time_zone_name must be a valid SkySpark timezone name.

pub async fn utc_his_write_num(
    &mut self,
    id: &Ref,
    time_zone_name: &str,
    his_data: &[(DateTime<Utc>, Number)]
) -> Result<Grid, Error>

Writes numeric values with UTC timestamps to a single point. unit must be a valid Haystack unit literal, such as L/s or celsius. time_zone_name must be a valid SkySpark timezone name.

pub async fn utc_his_write_str(
    &mut self,
    id: &Ref,
    time_zone_name: &str,
    his_data: &[(DateTime<Utc>, String)]
) -> Result<Grid, Error>

Writes string values with UTC timestamps to a single point. time_zone_name must be a valid SkySpark timezone name.

pub async fn nav(&mut self, nav_id: Option<&Ref>) -> Result<Grid, Error>

The Haystack nav operation.

pub async fn ops(&mut self) -> Result<Grid, Error>

Returns a grid containing the operations available on the server.

pub async fn read(
    &mut self,
    filter: &str,
    limit: Option<u64>
) -> Result<Grid, Error>

Returns a grid containing the records matching the given Axon filter string.

pub async fn read_by_ids(&mut self, ids: &[Ref]) -> Result<Grid, Error>

Returns a grid containing the records matching the given id Refs.

impl SkySparkClient

pub async fn eval(&mut self, axon_expr: &str) -> Result<Grid, Error>

Trait Implementations

impl Debug for SkySparkClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.