slung 0.1.0

An abstraction library for interacting with the Slung runtime.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# Slung Rust SDK

An abstraction library for interacting with the [*Slung runtime*](https://github.com/slunghq/slung).

## Quickstart

Add to your rust project's `Cargo.toml`:

```toml
[dependencies]
slung = "0.1.0"
```

And then at the top of your module:

```rust
use slung::prelude::*;
```

## Example
Here's a basic anomaly detection example:

```rust
use slung::prelude::*;

#[main]
fn main() -> Result<()> {
    // Subscribe to live stream updates.
    let handle = query_live("AVG:temp:[sensor=1]")?;
    poll_handle(handle, on_event, 100.0)?;

    Ok(())
}

fn on_event(event: Event, alert_threshold: f64) -> Result<()> {
    if event.value > alert_threshold {
        println!("event timestamp={} value={}", event.timestamp, event.value);
        for producer in event.producers {
            writeback_ws(producer, "ALERT: threshold exceeded")?;
        }
    }

    Ok(())
}
```

## Query Syntax

`OP:SERIES:[TAGS]:[RANGE]`

+ RANGE is optional
+ OP: AVG, MIN, MAX, SUM, COUNT
+ TAGS: AND, OR, NOT
+ RANGE: `[start_time,end_time]`. Timestamps in microseconds. Also supports sec, min, hour, day, week (short & plural forms apply).

## License

Unlike the root project, this SDK is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details.