Crate ax_types

source ·
Expand description

Latest Version Rust Documentation

AX Types

AX is a decentralized event database, streaming and processing engine that allows you to easily build local-first cooperative apps. It 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.

Note: AX has been created by the company Actyx AG and predates the unrelated Actix framework (although AX wasn’t open-sourced until Oct’23). While we have changed crate names to avoid confusion, the company name remains Actyx AG and appears in some places.

This crate defines the data types needed for communicating with Actyx. It should in most cases be used through the AX SDK.

Modules

  • service
  • types
    Types that you may want to use in describing the event payload data

Macros

  • app_id
    Macro for constructing an AppId literal.
  • tag
    Macro for constructing a Tag literal.
  • tags
    Macro for constructing a set of Tag values.

Structs

  • AppId
    The app ID denotes a specific app (sans versioning)
  • AppManifest
  • Event
    Events are delivered in this envelope together with their metadata
  • EventKey
    The sort key of an event
  • LamportTimestamp
    A logical timestamp taken from a Lamport clock
  • Metadata
    Metadata attached to an event that can be used for filtering.
  • NodeId
    The AX node identifier
  • Offset
    Event offset within a stream
  • OffsetMap
    Multi-dimensional cursor for event streams: an OffsetMap describes the set of events given by the event streams of each included source up to the associated Offset.
  • OffsetOrMin
    Event offset within a SourceId’s stream or MIN value
  • Opaque
    A ref-counted slice of memory holding a compact binary representation of an event payload
  • Payload
    Compact binary storage of events created when they are received
  • StreamId
    The unique identifier of a single event stream emitted by an AX node
  • StreamNr
    Stream number. Newtype alias for u64
  • Tag
    A Tag that semantically characterises an event.
  • TagSet
    A set of tags in canonical iteration order
  • Timestamp
    Microseconds since the UNIX epoch, without leap seconds and in UTC

Enums