[−][src]Crate actyxos_sdk

ActyxOS makes it easy to run distributed applications on multiple nodes. It is a piece of software that allows you to run your own apps on one or more edge devices and have these apps seamlessly communicate and share data with each other.

This crate defines the data types needed for communicating with ActyxOS and provides Rust bindings for the ActyxOS APIs. It also provides serialization instances for processing the events with differential-dataflow under the "dataflow" feature flag.

Examples

Below you find a full example using the EventService client that retrieves some events. Please adapt the semantics to match your stored events in order to see output.

Note: this example needs the client feature to compile

use actyxos_sdk::event_service::{EventService, EventServiceError, Order, Subscription};
use actyxos_sdk::semantics;
use futures::stream::StreamExt;

#[tokio::main]
pub async fn main() -> Result<(), EventServiceError> {
    // client for locally running ActyxOS Event Service
    let service = EventService::default();

    // retrieve largest currently known event stream cursor
    let offsets = service.get_offsets().await?;

    // all events matching the given subscription
    // sorted backwards, i.e. youngest to oldest
    let sub = vec![Subscription::wildcard(semantics!("MyFish"))];
    let mut events = service
        .query_upto(offsets, sub, Order::LamportReverse)
        .await?;

    // print out the payload of each event
    // (cf. Payload::extract for more options)
    while let Some(event) = events.next().await {
        println!("{}", event.payload.json_value());
    }
    Ok(())
}

Feature flags

The default is to provide only the data types with serialization and deserialization support for serde. The following features can be enabled in addition:

client: include HTTP client bindings using the reqwest crate
dataflow: provide Abomonation instances for use with tools like Differential Dataflow

Modules

event	Definition of the event envelope structure provided by ActyxOS
event_service	Data types needed for interacting with the ActyxOS Event Service, plus an optional HTTP client binding
types	Types that you may want to use in describing the event payload data

Macros

arcval_scalar	Helper macro to create interned string types
fish_name	Macro for constructing a `FishName` literal.
semantics	Macro for constructing a `Semantics` literal.
source_id	Macro for constructing a `SourceId` literal.
tag	Macro for constructing a `Tag` literal.
tags	Macro for constructing a set of `Tag` values.