Struct SkySparkClient 

pub struct SkySparkClient { /* private fields */ }

A client for interacting with a SkySpark server.

Implementations

impl SkySparkClient

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

Create a new SkySparkClient.

Example

use raystack_blocking::SkySparkClient;
use url::Url;
let url = Url::parse("https://skyspark.company.com/api/bigProject/").unwrap();
let mut client = SkySparkClient::new(url, "username", "p4ssw0rd").unwrap();

Examples found in repository

examples/client.rs (line 16)

fn main() -> Result<(), Box<dyn Error>> {
    use raystack_blocking::{SkySparkClient, ValueExt};
    use url::Url;

    let url = Url::parse("https://www.example.com/api/projName/")?;

    // If you are going to create many `SkySparkClient`s,
    // reuse the same `reqwest::Client` in each `SkySparkClient`
    // by using the `SkySparkClient::new_with_client` function instead.
    let mut client = SkySparkClient::new(url, "username", "p4ssw0rd")?;

    let sites_grid = client.eval("readAll(site)")?;

    // Print the raw JSON:
    println!("{}", sites_grid.to_json_string_pretty());

    // Working with the Grid struct:
    println!("All columns: {:?}", sites_grid.cols());
    println!(
        "first site id: {:?}",
        sites_grid.rows()[0]["id"].as_hs_ref().unwrap()
    );

    Ok(())
}

pub fn new_with_runtime( project_api_url: Url, username: &str, password: &str, rt: Arc<Runtime>, ) -> Result<Self, NewSkySparkClientError>

Create a new SkySparkClient using an existing Tokio runtime.

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 fn about(&mut self) -> Result<Grid, Error>

Returns a grid containing basic server information.

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

Returns a grid describing what MIME types are available.

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

Returns a grid of history data for a single point.

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

Writes boolean values to a single point.

pub 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 fn his_write_str( &mut self, id: &Ref, his_data: &[(DateTime, String)], ) -> Result<Grid, Error>

Writes string values to a single point.

pub 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 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 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 fn nav(&mut self, nav_id: Option<&Ref>) -> Result<Grid, Error>

The Haystack nav operation.

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

Returns a grid containing the operations available on the server.

pub 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 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 fn eval(&mut self, axon_expr: &str) -> Result<Grid, Error>

Examples found in repository

examples/quick_client.rs (line 8)

fn main() -> Result<(), Box<dyn Error>> {
    use raystack_blocking::{new_client, ValueExt};

    let mut client = new_client("https://www.example.com/api/projName/", "username", "p4ssw0rd")?;

    let sites_grid = client.eval("readAll(site)")?;

    // Print the raw JSON:
    println!("{}", sites_grid.to_json_string_pretty());

    // Working with the Grid struct:
    println!("All columns: {:?}", sites_grid.cols());
    println!(
        "first site id: {:?}",
        sites_grid.rows()[0]["id"].as_hs_ref().unwrap()
    );

    Ok(())
}

examples/client.rs (line 18)

fn main() -> Result<(), Box<dyn Error>> {
    use raystack_blocking::{SkySparkClient, ValueExt};
    use url::Url;

    let url = Url::parse("https://www.example.com/api/projName/")?;

    // If you are going to create many `SkySparkClient`s,
    // reuse the same `reqwest::Client` in each `SkySparkClient`
    // by using the `SkySparkClient::new_with_client` function instead.
    let mut client = SkySparkClient::new(url, "username", "p4ssw0rd")?;

    let sites_grid = client.eval("readAll(site)")?;

    // Print the raw JSON:
    println!("{}", sites_grid.to_json_string_pretty());

    // Working with the Grid struct:
    println!("All columns: {:?}", sites_grid.cols());
    println!(
        "first site id: {:?}",
        sites_grid.rows()[0]["id"].as_hs_ref().unwrap()
    );

    Ok(())
}

Trait Implementations

impl Debug for SkySparkClient

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

Formats the value using the given formatter.