Crate raystack[−][src]
Expand description
Overview
This crate provides functions which can query a SkySpark server, using
the Haystack REST API and the SkySpark REST API’s eval
operation.
Some Haystack operations are not implemented
(watch* operations, pointWrite and invokeAction).
Example Usage
Put this in the main function in the main.rs
file to create
and use a SkySparkClient
:
use raystack::{SkySparkClient, ValueExt};
use url::Url;
let url = Url::parse("https://www.example.com/api/projName/").unwrap();
let mut client = SkySparkClient::new(url, "username", "p4ssw0rd").await.unwrap();
let sites_grid = client.eval("readAll(site)").await.unwrap();
// 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());
See the examples
folder for more usage examples.
The Grid struct is a wrapper around the underlying JSON Value enum
provided by the serde_json
crate. See the
documentation for Value
for more information on how to query for data stored within it.
Additional functions for extracting Haystack values from the underlying
JSON are found in this crate’s ValueExt
trait.
Modules
Structs
A Haystack Number, encapsulating a scalar value and an optional unit value. The unit is represented as a string. This does not represent Haystack scientific notation numbers.
A Haystack Coord, representing a geographical coordinate.
A Haystack Date with no time zone.
A Haystack DateTime.
A wrapper around a serde_json::Value
which represents a Haystack Grid.
Columns will always be sorted in alphabetical order.
A Haystack marker.
A Haystack NA (not available).
Error denoting that a JSON value could not be parsed into a Grid
.
An error indicating that a Ref
could not be parsed.
An error indicating that a TagName
could not be parsed.
A Haystack Ref.
A Haystack remove marker.
A Haystack scientific notation Number, encapsulating a value and an optional unit value. The unit is represented as a string.
A client for interacting with a SkySpark server.
A Haystack Symbol.
A Haystack tag name.
A Haystack Time with no time zone.
A Haystack Uri.
A Haystack XStr.
Enums
Describes the kinds of errors that can occur in this crate.
Represents the different time range queries that can be sent
as part of the hisRead
Haystack operation.
Errors that can occur when creating a new SkySparkClient
.
A Haystack number.
Traits
Something which can be converted to and from Hayson (the new JSON encoding used by Project Haystack).
An extension trait for the serde_json::Value
enum,
containing helper functions which make it easier to
parse specific Haystack types from the underlying Hayson encoding
(a JSON value in a specific format, see https://github.com/j2inn/hayson).
Functions
Return true if the string is a valid tag name.
Converts a string containing a SkySpark time zone name into the matching
Tz
variant from the chrono_tz crate.