Azure Eventhub Rust

1---
2name: azure-eventhub-rust
3description: |
4  Azure Event Hubs SDK for Rust. Use for sending and receiving events, streaming data ingestion.
5  Triggers: "event hubs rust", "ProducerClient rust", "ConsumerClient rust", "send event rust", "streaming rust".
6package: azure_messaging_eventhubs
7---
8 
9# Azure Event Hubs SDK for Rust
10 
11Client library for Azure Event Hubs — big data streaming platform and event ingestion service.
12 
13## Installation
14 
15```sh
16cargo add azure_messaging_eventhubs azure_identity
17```
18 
19## Environment Variables
20 
21```bash
22EVENTHUBS_HOST=<namespace>.servicebus.windows.net
23EVENTHUB_NAME=<eventhub-name>
24```
25 
26## Key Concepts
27 
28- **Namespace** — container for Event Hubs
29- **Event Hub** — stream of events partitioned for parallel processing
30- **Partition** — ordered sequence of events
31- **Producer** — sends events to Event Hub
32- **Consumer** — receives events from partitions
33 
34## Producer Client
35 
36### Create Producer
37 
38```rust
39use azure_identity::DeveloperToolsCredential;
40use azure_messaging_eventhubs::ProducerClient;
41 
42let credential = DeveloperToolsCredential::new(None)?;
43let producer = ProducerClient::builder()
44    .open("<namespace>.servicebus.windows.net", "eventhub-name", credential.clone())
45    .await?;
46```
47 
48### Send Single Event
49 
50```rust
51producer.send_event(vec![1, 2, 3, 4], None).await?;
52```
53 
54### Send Batch
55 
56```rust
57let batch = producer.create_batch(None).await?;
58batch.try_add_event_data(b"event 1".to_vec(), None)?;
59batch.try_add_event_data(b"event 2".to_vec(), None)?;
60 
61producer.send_batch(batch, None).await?;
62```
63 
64## Consumer Client
65 
66### Create Consumer
67 
68```rust
69use azure_messaging_eventhubs::ConsumerClient;
70 
71let credential = DeveloperToolsCredential::new(None)?;
72let consumer = ConsumerClient::builder()
73    .open("<namespace>.servicebus.windows.net", "eventhub-name", credential.clone())
74    .await?;
75```
76 
77### Receive Events
78 
79```rust
80// Open receiver for specific partition
81let receiver = consumer.open_partition_receiver("0", None).await?;
82 
83// Receive events
84let events = receiver.receive_events(100, None).await?;
85for event in events {
86    println!("Event data: {:?}", event.body());
87}
88```
89 
90### Get Event Hub Properties
91 
92```rust
93let properties = consumer.get_eventhub_properties(None).await?;
94println!("Partitions: {:?}", properties.partition_ids);
95```
96 
97### Get Partition Properties
98 
99```rust
100let partition_props = consumer.get_partition_properties("0", None).await?;
101println!("Last sequence number: {}", partition_props.last_enqueued_sequence_number);
102```
103 
104## Best Practices
105 
1061. **Reuse clients** — create once, send many events
1072. **Use batches** — more efficient than individual sends
1083. **Check batch capacity** — `try_add_event_data` returns false when full
1094. **Process partitions in parallel** — each partition can be consumed independently
1105. **Use consumer groups** — isolate different consuming applications
1116. **Handle checkpointing** — use `azure_messaging_eventhubs_checkpointstore_blob` for distributed consumers
112 
113## Checkpoint Store (Optional)
114 
115For distributed consumers with checkpointing:
116 
117```sh
118cargo add azure_messaging_eventhubs_checkpointstore_blob
119```
120 
121## Reference Links
122 
123| Resource | Link |
124|----------|------|
125| API Reference | https://docs.rs/azure_messaging_eventhubs |
126| Source Code | https://github.com/Azure/azure-sdk-for-rust/tree/main/sdk/eventhubs/azure_messaging_eventhubs |
127| crates.io | https://crates.io/crates/azure_messaging_eventhubs |
128