9 releases (breaking)

0.7.0 Feb 24, 2023
0.6.0 Nov 7, 2022
0.5.0 Mar 18, 2022
0.4.0 Jul 7, 2021
0.0.1 Mar 13, 2020

#790 in Web programming

Download history 3846/week @ 2024-03-14 3853/week @ 2024-03-21 3069/week @ 2024-03-28 3494/week @ 2024-04-04 3573/week @ 2024-04-11 2674/week @ 2024-04-18 2640/week @ 2024-04-25 3203/week @ 2024-05-02 3607/week @ 2024-05-09 3071/week @ 2024-05-16 3493/week @ 2024-05-23 3395/week @ 2024-05-30 3707/week @ 2024-06-06 4126/week @ 2024-06-13 3895/week @ 2024-06-20 3319/week @ 2024-06-27

15,518 downloads per month
Used in 23 crates (18 directly)

Custom license

220KB
5K SLoC

CloudEvents SDK Rust Crates badge Docs badge

This project implements the CloudEvents Spec for Rust.

Note: This project is WIP under active development, hence all APIs are considered unstable.

Spec support

v0.3 v1.0
CloudEvents Core
AMQP Protocol Binding
AVRO Event Format
HTTP Protocol Binding
JSON Event Format
Kafka Protocol Binding
MQTT Protocol Binding
NATS Protocol Binding
Web hook

Crate Structure

The core modules include definitions for the Event and EventBuilder data structures, JSON serialization rules, and a mechanism to support various Protocol Bindings, each of which is enabled by a specific feature flag:

  • actix: Integration with actix.
  • axum: Integration with axum.
  • warp: Integration with warp.
  • reqwest: Integration with reqwest.
  • rdkafka: Integration with rdkafka.
  • nats: Integration with nats

This crate is continuously tested to work with GNU libc, WASM and musl toolchains.

Get Started

To get started, add the dependency to Cargo.toml, optionally enabling your Protocol Binding of choice:

[dependencies]
cloudevents-sdk = { version = "0.7.0" }

Now you can start creating events:

use cloudevents::{EventBuilder, EventBuilderV10};
use url::Url;

let event = EventBuilderV10::new()
    .id("aaa")
    .source(Url::parse("http://localhost").unwrap())
    .ty("example.demo")
    .build()?;

Checkout the examples using our integrations to learn how to send and receive events:

Development & Contributing

If you're interested in contributing to sdk-rust, look at Contributing documentation

Community

Each SDK may have its own unique processes, tooling and guidelines, common governance related material can be found in the CloudEvents community directory. In particular, in there you will find information concerning how SDK projects are managed, guidelines for how PR reviews and approval, and our Code of Conduct information.

Dependencies

~4–23MB
~382K SLoC