Struct SubscribeOpts 

pub struct SubscribeOpts {
    pub subscription_name: Option<String>,
    pub topic_key_filter: Option<String>,
    pub mode: SubscriptionMode,
    pub consumer_group: Option<GroupOpts>,
}

Options for subscribing to a topic.

Examples

Ephemeral stream with partition filter (see keyed_topic example):

use photon_backend::SubscribeOpts;

let opts = SubscribeOpts::default_ephemeral().topic_key_filter("alice");

Durable broadcast by subscription name:

use photon_backend::SubscribeOpts;

let opts = SubscribeOpts::broadcast().subscription_name("my-worker");

Fields

subscription_name: Option<String>

Subscription name (required for durable broadcast mode).

topic_key_filter: Option<String>

Filter by topic key (for keyed topics).

mode: SubscriptionMode

Durable or ephemeral mode.

consumer_group: Option<GroupOpts>

Consumer group (load-balanced); mutually exclusive with durable subscription name.

Implementations

impl SubscribeOpts

pub const fn default_ephemeral() -> SubscribeOpts

Create default options (ephemeral, no key filter).

pub fn broadcast() -> SubscribeOpts

Broadcast durable subscription (today’s default).

pub fn consumer_group(self, opts: GroupOpts) -> SubscribeOpts

Load-balanced consumer group subscription.

pub fn subscription_name(self, name: impl Into<String>) -> SubscribeOpts

Set subscription name (for durable mode).

pub fn topic_key_filter(self, key: impl Into<String>) -> SubscribeOpts

Set topic key filter.

pub const fn mode(self, mode: SubscriptionMode) -> SubscribeOpts

Set mode.

Trait Implementations

impl Clone for SubscribeOpts

fn clone(&self) -> SubscribeOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscribeOpts

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

Formats the value using the given formatter.

impl Default for SubscribeOpts

fn default() -> SubscribeOpts

Returns the “default value” for a type.