Struct pulsar::consumer::options::ConsumerOptions

pub struct ConsumerOptions {
    pub priority_level: Option<i32>,
    pub durable: Option<bool>,
    pub start_message_id: Option<MessageIdData>,
    pub metadata: BTreeMap<String, String>,
    pub read_compacted: Option<bool>,
    pub schema: Option<Schema>,
    pub initial_position: InitialPosition,
}

Configuration options for consumers

Fields

priority_level: Option<i32>

durable: Option<bool>

Signal whether the subscription should be backed by a durable cursor or not

start_message_id: Option<MessageIdData>

If specified, the subscription will position the cursor marked-delete position on the particular message id and will send messages from that point

metadata: BTreeMap<String, String>

Add optional metadata key=value to this consumer

read_compacted: Option<bool>

schema: Option<Schema>

initial_position: InitialPosition

Signal whether the subscription will initialize on latest or earliest message (default on latest)

an enum can be used to initialize it:

ConsumerOptions {
    initial_position: InitialPosition::Earliest,
}

Implementations

impl ConsumerOptions

pub fn with_priority_level(self, priority_level: i32) -> Self

within options, sets the priority level

pub fn durable(self, durable: bool) -> Self

pub fn starting_on_message(self, message_id_data: MessageIdData) -> Self

pub fn with_metadata(self, metadata: BTreeMap<String, String>) -> Self

pub fn read_compacted(self, read_compacted: bool) -> Self

pub fn with_schema(self, schema: Schema) -> Self

pub fn with_initial_position(self, initial_position: InitialPosition) -> Self

Trait Implementations

impl Clone for ConsumerOptions

fn clone(&self) -> ConsumerOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConsumerOptions

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

Formats the value using the given formatter.

impl Default for ConsumerOptions

fn default() -> ConsumerOptions

Returns the “default value” for a type.