Struct IncomingMessage 

pub struct IncomingMessage {
    pub id: MessageId,
    pub metadata: Arc<MessageMetadata>,
    pub payload: Bytes,
    pub redelivery_count: u32,
    pub broker_entry_metadata: Option<Arc<BrokerEntryMetadata>>,
}

Convenience alias for an incoming message handed back to the caller.

Fields

id: MessageId

Message id assigned by the broker.

metadata: Arc<MessageMetadata>

Pulsar MessageMetadata for the message. Refcounted (Arc) so the batched-delivery path inside the consumer state machine can share one parsed metadata across every sub-message of a batch instead of deep-cloning per message. Field access works transparently (Arc derefs).

payload: Bytes

Application payload bytes (post-decompression / post-decryption).

redelivery_count: u32

Broker-supplied redelivery count.

broker_entry_metadata: Option<Arc<BrokerEntryMetadata>>

PIP-90 BrokerEntryMetadata. None when the broker did not stamp one (older brokers / disabled namespace policy). Carries the broker’s wall-clock timestamp and per-topic index — useful for routing, dedup, and exactly-once-ish flows.

Implementations

impl IncomingMessage

pub fn key(&self) -> Option<&str>

Mirrors Java Message#getKey. Returns None for keyless messages.

pub fn has_key(&self) -> bool

Mirrors Java Message#hasKey.

pub fn ordering_key(&self) -> Option<&Bytes>

Mirrors Java Message#getOrderingKey. Returns None if unset.

pub fn publish_time_ms(&self) -> u64

Mirrors Java Message#getPublishTime — millis since the UNIX epoch as stamped by the producer’s state machine at queue time.

pub fn event_time_ms(&self) -> u64

Mirrors Java Message#getEventTime. Returns 0 if the producer didn’t stamp one (Java returns 0 in the same situation).

pub fn sequence_id(&self) -> u64

Mirrors Java Message#getSequenceId. The sequence id assigned by the producer’s state machine (visible alongside the broker-assigned message id).

pub fn producer_name(&self) -> &str

Mirrors Java Message#getProducerName.

pub fn property(&self, key: &str) -> Option<&str>

Mirrors Java Message#getProperty(String). Returns the value for the first matching property entry, or None if absent.

pub fn properties(&self) -> impl Iterator<Item = (&str, &str)>

Mirrors Java Message#getProperties — every (key, value) pair on the message.

pub fn redelivery_count(&self) -> u32

Mirrors Java Message#getRedeliveryCount. The broker-side count of how many times this message has been redelivered.

pub fn replicated_from(&self) -> Option<&str>

Mirrors Java Message#getReplicatedFrom. None if the message wasn’t replicated.

pub fn is_replicated(&self) -> bool

Mirrors Java Message#isReplicated. true if this message was geo-replicated from another cluster — equivalent to replicated_from().is_some().

pub fn is_batched(&self) -> bool

true if the message arrived as part of a batched entry. The position within the batch is on id.batch_index. Useful for partial-batch ack logic and telemetry.

pub fn is_partitioned(&self) -> bool

true if the message arrived on a partitioned topic. The partition index is on id.partition.

pub fn size(&self) -> usize

Payload size in bytes (post-decompression / post-decryption). Mirrors Java Message#size. Equivalent to self.payload.len().

pub fn is_empty(&self) -> bool

true if the payload is empty — the Pulsar convention for a tombstone in a compacted topic. Mirrors Java Message#isEmpty.

pub fn has_replicate_to(&self) -> bool

Mirrors Java Message#hasReplicateTo. true when the producer stamped an explicit replication cluster list (via OutgoingMessage::replication_clusters / disable_replication).

pub fn replicate_to(&self) -> &[String]

Mirrors Java Message#getReplicateTo. Returns the cluster ids the message was pinned to, or an empty slice when the producer used the namespace default.

pub fn has_event_time(&self) -> bool

Mirrors Java Message#hasEventTime. true if the producer stamped a non-zero event-time (Java distinguishes “unset” from “stamped 0” via this predicate).

pub fn has_ordering_key(&self) -> bool

Mirrors Java Message#hasOrderingKey.

pub fn has_property(&self, key: &str) -> bool

Mirrors Java Message#hasProperty(String).

pub fn has_properties(&self) -> bool

Mirrors Java Message#hasProperties — true if the message carries at least one (key, value) property entry.

pub fn schema_version(&self) -> Option<&[u8]>

Mirrors Java Message#getSchemaVersion. None for messages produced by schemaless producers (or via auto-produce-bytes).

pub fn broker_publish_time_ms(&self) -> Option<u64>

PIP-90 broker timestamp — wall-clock millis since epoch the broker assigned when it persisted the entry. Returns None when the namespace policy disables broker-entry metadata or the broker is older than PIP-90.

pub fn broker_index(&self) -> Option<u64>

PIP-90 per-topic broker index — monotonic offset the broker assigned when it persisted the entry. None under the same conditions as Self::broker_publish_time_ms.

pub fn has_encryption(&self) -> bool

true if the message metadata carries PIP-4 encryption context (one or more wrapped symmetric keys + the encryption algorithm name). Useful for callers running with CryptoFailureAction::Consume who want to know whether they need to attempt out-of-band decryption.

pub fn encryption_algorithm(&self) -> Option<&str>

PIP-4 encryption algorithm name (e.g. "AES/GCM/NoPadding"). None if the producer did not encrypt this message.

pub fn encryption_keys(&self) -> &[EncryptionKeys]

PIP-4 wrapped symmetric-key entries. Empty slice when the producer did not encrypt this message. Each entry carries the key name + the ciphertext-wrapped data key the broker echoed back from the producer’s CryptoKeyReader.

pub fn encryption_param(&self) -> Option<&[u8]>

PIP-4 encryption parameter bytes (typically the AES GCM IV/nonce). None if the producer did not encrypt this message.

Trait Implementations

impl Clone for IncomingMessage

fn clone(&self) -> IncomingMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncomingMessage

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

Formats the value using the given formatter.

impl From<IncomingMessage> for IncomingMessage

fn from(msg: IncomingMessage) -> Self

Converts to this type from the input type.