Struct azeventhubs::consumer::ReadEventOptions

pub struct ReadEventOptions {
    pub prefetch_count: u32,
    pub owner_level: Option<i64>,
    pub track_last_enqueued_event_properties: bool,
}

The set of options that can be specified to configure behavior when reading events from an EventHubConsumerClient

Fields

prefetch_count: u32

The number of events that will be eagerly requested from the Event Hubs service and queued locally without regard to whether a read operation is currently active, intended to help maximize throughput by allowing events to be read from from a local cache rather than waiting on a service request.

Default to DEFAULT_PREFETCH_COUNT

owner_level: Option<i64>

When populated, the owner level indicates that a reading is intended to be performed exclusively for events in the requested partition and for the associated consumer group. To do so, reading will attempt to assert ownership over the partition; in the case where more than one exclusive reader in the consumer group attempts to assert ownership for the same partition, the one having a larger owner_level value will “win”.

When an exclusive reader is used, other readers which are non-exclusive or which have a lower owner level will either not be allowed to be created, if they already exist, will encounter an exception during the next attempted operation.

track_last_enqueued_event_properties: bool

Indicates whether or not the reader should request information on the last enqueued event on the partition associated with a given event, and track that information as events are read.

When information about a partition’s last enqueued event is being tracked, each event received from the Event Hubs service will carry metadata about the partition that it otherwise would not. This results in a small amount of additional network bandwidth consumption that is generally a favorable trade-off when considered against periodically making requests for partition properties using one of the Event Hub clients.

Implementations

impl ReadEventOptions

pub fn new() -> Self

Creates a new instance with default values.

pub fn with_prefetch_count(self, prefetch_count: u32) -> Self

Sets the prefetch count.

pub fn with_owner_level(self, owner_level: i64) -> Self

Sets the owner level.

pub fn with_track_last_enqueued_event_properties( self, track_last_enqueued_event_properties: bool ) -> Self

Sets the track last enqueued event properties.

Trait Implementations

impl Clone for ReadEventOptions

fn clone(&self) -> ReadEventOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReadEventOptions

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

Formats the value using the given formatter.

impl Default for ReadEventOptions

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ReadEventOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ReadEventOptions

fn eq(&self, other: &ReadEventOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ReadEventOptions

impl StructuralEq for ReadEventOptions

impl StructuralPartialEq for ReadEventOptions