Skip to content

StreamMessage

faststream.broker.message.StreamMessage dataclass #

StreamMessage(raw_message, body, headers=dict(), batch_headers=list(), path=dict(), content_type=None, reply_to='', message_id=gen_cor_id(), correlation_id=gen_cor_id(), _source_type=Consume)

Bases: Generic[MsgType]

Generic class to represent a stream message.

raw_message instance-attribute #

raw_message

body instance-attribute #

body

headers class-attribute instance-attribute #

headers = field(default_factory=dict)

batch_headers class-attribute instance-attribute #

batch_headers = field(default_factory=list)

path class-attribute instance-attribute #

path = field(default_factory=dict)

content_type class-attribute instance-attribute #

content_type = None

reply_to class-attribute instance-attribute #

reply_to = ''

message_id class-attribute instance-attribute #

message_id = field(default_factory=gen_cor_id)

correlation_id class-attribute instance-attribute #

correlation_id = field(default_factory=gen_cor_id)

processed class-attribute instance-attribute #

processed = field(default=False, init=False)

committed class-attribute instance-attribute #

committed = field(default=None, init=False)

decoded_body property writable #

decoded_body

ack async #

ack()
Source code in faststream/broker/message.py 
74
75
76
async def ack(self) -> None:
    if not self.committed:
        self.committed = AckStatus.acked

nack async #

nack()
Source code in faststream/broker/message.py 
78
79
80
async def nack(self) -> None:
    if not self.committed:
        self.committed = AckStatus.nacked

reject async #

reject()
Source code in faststream/broker/message.py 
82
83
84
async def reject(self) -> None:
    if not self.committed:
        self.committed = AckStatus.rejected

decode async #

decode()

Serialize the message by lazy decoder.

Source code in faststream/broker/message.py 
86
87
88
89
async def decode(self) -> Optional["DecodedMessage"]:
    """Serialize the message by lazy decoder."""
    # TODO: make it lazy after `decoded_body` removed
    return self._decoded_body