Struct PulsarPublishOptions 

pub struct PulsarPublishOptions {
    pub partition_key: Option<String>,
}

What one Pulsar publish differs from the next in.

Every field is optional: a message carries what its call site named with a step of PulsarPublishSteps, and nothing else. The PulsarPublish policy fixes no key of its own, so a publish that names no step goes unkeyed.

Examples

A test reads them back off the slot the handler published through:

use std::error::Error;

use ruststream::testing::TestApp;
use ruststream_pulsar::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Deserialize, Outgoing, Serialize)]
struct Order {
    id: u64,
}

#[derive(Outgoing, Serialize)]
struct Receipt {
    id: u64,
}

#[derive(OutSlot)]
#[publishes(Receipt)]
struct Ledger;

#[subscriber(PulsarSubscription::new("orders", "workers"))]
async fn record(
    order: &Order,
    Out(ledger): Out<impl Publisher<Options = PulsarPublishOptions>, Ledger>,
) -> HandlerOutcome {
    let sent = ledger
        .message(&Receipt { id: order.id })
        .to("receipts")
        .partition_key(format!("user-{}", order.id))
        .publish()
        .await;
    if sent.is_err() {
        return HandlerOutcome::retry();
    }
    HandlerOutcome::ack()
}

pub fn app() -> RustStream {
    RustStream::new(AppInfo::new("orders", "0.1.0"))
        .with_broker(PulsarBroker::new("pulsar://localhost:6650"), |b| {
            b.include(record).out(Ledger, Publish).build();
        })
}

pub async fn a_receipt_is_keyed_by_its_user() -> Result<(), Box<dyn Error>> {
    let tb = TestApp::start(app()).await?;
    tb.broker::<PulsarBroker>()
        .message(&Order { id: 7 })
        .to("orders")
        .publish()
        .await?;

    tb.out::<Ledger>()
        .assert_called_once()
        .with_options(&PulsarPublishOptions {
            partition_key: Some("user-7".to_owned()),
        });
    tb.shutdown().await?;
    Ok(())
}

Fields

partition_key: Option<String>

The message’s partition key: keyed routing places the message by it and KeyShared subscriptions order by it.

None leaves the key to the partition-key header, the portable spelling of the same value; with neither, the message is unkeyed.

Trait Implementations

impl Clone for PulsarPublishOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PulsarPublishOptions

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

Formats the value using the given formatter.

impl Default for PulsarPublishOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PulsarPublishOptions

impl PartialEq for PulsarPublishOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PulsarPublishOptions