Struct FileMessage 

pub struct FileMessage { /* private fields */ }

A delivery from a stream file: the transport’s SeaMessage plus the subscription’s reposition handle.

The handle is what makes the file transport’s per-delivery context (FileContext) buildable, and carrying it in the message type is what keeps that context off the transports that cannot seek: standard input yields a plain SeaMessage, so a handler declaring the seeking context does not compile against it.

Implementations

impl FileMessage

pub fn stream(&self) -> &str

The stream key this message was published to.

Trait Implementations

impl BuildBatchContext<FileMessage> for FileBatchContext

fn build(first: &FileMessage) -> Self

Builds the context value by reading subscription-scoped fields out of the batch’s first delivery, or out of the batch itself where it lends its values as one slice.

impl BuildContext<FileMessage> for FileContext

fn build(msg: &FileMessage) -> Self

Builds the context value by reading fields out of msg.

impl Debug for FileMessage

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

Formats the value using the given formatter.

impl IncomingMessage for FileMessage

fn payload(&self) -> &[u8]

Returns the raw payload of the message.

fn headers(&self) -> &HeaderMap

Returns the headers attached to the message.

fn ack(self) -> impl Future<Output = Result<(), AckError>>

Acknowledges successful processing. Consumes the message handle.

fn nack(self, requeue: bool) -> impl Future<Output = Result<(), AckError>>

Negatively acknowledges the message. When requeue is true the broker should redeliver according to its own retry policy; when false it should drop or dead-letter the message.

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

Returns the routing key the broker partitioned this message by, or None when the message carries no key.

fn redelivery_count(&self) -> Option<u64>

How many times the broker has delivered this message, counting this delivery. None where the transport counts nothing.

fn decode_error(&self) -> Option<&CodecError>

The error the broker met while reading this delivery, or None when it read the delivery whole.

fn supports_nack_after(&self) -> bool

Reports whether this transport can honor nack_after natively.

fn nack_after( self, delay: Duration, ) -> impl Future<Output = Result<(), AckError>> + Send

where Self: Sized,

Negatively acknowledges the message, asking the broker to redeliver it no sooner than delay from now.

impl Positioned for FileMessage

type Position = FilePosition

The position type, matching the subscription’s Seeker::Position.

fn position(&self) -> FilePosition

Returns the position of this delivery; seeking to it redelivers this message.