Struct EventHubProducerClient 

pub struct EventHubProducerClient<RP> { /* private fields */ }

A client responsible for publishing EventData to a specific Event Hub, grouped together in batches. Depending on the options specified when sending, events may be automatically assigned an available partition or may request a specific partition.

The EventHubProducerClient publishes immediately, ensuring a deterministic outcome for each send operation, though requires that callers own the responsibility of building and managing batches.

Implementations

impl EventHubProducerClient<BasicRetryPolicy>

pub fn with_policy<P>() -> EventHubProducerClientBuilder<P>

where P: EventHubsRetryPolicy + Send,

Creates a new client with a custom retry policy.

pub async fn new_from_connection_string( connection_string: impl Into<String>, event_hub_name: impl Into<Option<String>>, client_options: EventHubProducerClientOptions, ) -> Result<Self, Error>

Creates a EventHubProducerClient using a connection string.

pub async fn new_from_credential( fully_qualified_namespace: impl Into<String>, event_hub_name: impl Into<String>, credential: impl Into<EventHubTokenCredential>, client_options: EventHubProducerClientOptions, ) -> Result<Self, Error>

Creates a EventHubProducerClient using a namespace and a credential.

pub async fn new_from_named_key_credential( fully_qualified_namespace: impl Into<String>, event_hub_name: impl Into<String>, credential: AzureNamedKeyCredential, client_options: EventHubProducerClientOptions, ) -> Result<Self, Error>

Creates a EventHubProducerClient using a namespace and a AzureNamedKeyCredential.

pub async fn new_from_sas_credential( fully_qualified_namespace: impl Into<String>, event_hub_name: impl Into<String>, credential: AzureSasCredential, client_options: EventHubProducerClientOptions, ) -> Result<Self, Error>

Creates a EventHubProducerClient using a namespace and a AzureSasCredential.

pub fn with_connection( connection: &mut EventHubConnection, client_options: EventHubProducerClientOptions, ) -> Self

Creates a EventHubProducerClient using a EventHubConnection.

impl<RP> EventHubProducerClient<RP>

where RP: EventHubsRetryPolicy + From<EventHubsRetryOptions> + Send,

pub async fn create_batch( &mut self, options: CreateBatchOptions, ) -> Result<EventDataBatch, Error>

Creates a new EventDataBatch with the given options.

pub async fn send_event( &mut self, event: impl Into<EventData>, options: SendEventOptions, ) -> Result<(), Error>

Sends a single event to the Event Hub.

pub async fn send_events<E>( &mut self, events: E, options: SendEventOptions, ) -> Result<(), Error>

where E: IntoIterator<Item = EventData>, E::IntoIter: ExactSizeIterator + Send,

Sends a set of events to the Event Hub.

pub async fn send_batch( &mut self, batch: EventDataBatch, options: SendEventOptions, ) -> Result<(), Error>

Sends a batch of events to the Event Hub.

pub async fn get_event_hub_properties( &mut self, ) -> Result<EventHubProperties, Error>

Retrieves information about the Event Hub that the connection is associated with, including the number of partitions present and their identifiers.

pub async fn get_partition_ids(&mut self) -> Result<Vec<String>, Error>

Retrieves the set of identifiers for the partitions of an Event Hub.

pub async fn get_partition_properties( &mut self, partition_id: &str, ) -> Result<PartitionProperties, Error>

Retrieves information about a specific partition for an Event Hub, including elements that describe the available events in the partition event stream.

pub async fn close(self) -> Result<(), Error>

Performs the task needed to clean up resources used by the EventHubProducerClient, including ensuring that the client itself has been closed.

This won’t close the underlying connection if the connection was shared among multiple clients.

Trait Implementations

impl<RP: Debug> Debug for EventHubProducerClient<RP>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.