|
6 | 6 | // cspell: words amqp eventdata |
7 | 7 | #![doc = include_str!("../README.md")] |
8 | 8 |
|
9 | | -/// This module contains the implementation of the Azure Messaging Event Hubs SDK for Rust. |
10 | | -/// |
11 | | -/// The SDK provides types and functions to interact with Azure Event Hubs, which is a highly scalable data streaming platform and event ingestion service. |
12 | | -/// It allows you to consume events from an Event Hub and create/send events to an Event Hub. |
13 | | -/// |
14 | | -/// # Examples |
15 | | -/// |
16 | | -/// Consuming events from an Event Hub: |
17 | | -/// |
18 | | -/// ```no_run |
19 | | -/// # use azure_identity::{DefaultAzureCredential, TokenCredentialOptions}; |
20 | | -/// # #[tokio::main] |
21 | | -/// # async fn main() -> Result<(), Box<dyn std::error::Error + 'static>> { |
22 | | -/// # let my_credentials = DefaultAzureCredential::new()?; |
23 | | -
|
24 | | -/// use azure_messaging_eventhubs::consumer::ConsumerClient; |
25 | | -/// use azure_messaging_eventhubs::models::EventData; |
26 | | -/// |
27 | | -/// let consumer_client = ConsumerClient::new("fully_qualified_domain", "eventhub_name", None, my_credentials, None); |
28 | | -/// let partition_properties = consumer_client.get_partition_properties("0").await?; |
29 | | -/// # Ok(()) |
30 | | -/// } |
31 | | -/// ``` |
32 | | -/// |
33 | 9 | pub(crate) mod common; |
34 | 10 |
|
35 | 11 | /// Types related to consuming events from an Event Hub. |
@@ -408,8 +384,8 @@ pub mod models { |
408 | 384 | } |
409 | 385 |
|
410 | 386 | /// Represents the data associated with an event received from an Event Hub. |
411 | | - /// This struct provides the event data, enqueued time, offset, sequence number, partition key, and system properties of the event. |
412 | 387 | /// |
| 388 | + /// This struct provides the event data, enqueued time, offset, sequence number, partition key, and system properties of the event. |
413 | 389 | pub struct ReceivedEventData { |
414 | 390 | message: AmqpMessage, |
415 | 391 | event_data: EventData, |
|
0 commit comments