Skip to content

encode_message

faststream.broker.parsers.encode_message #

encode_message(msg: Union[Sequence[SendableMessage], SendableMessage]) -> Tuple[bytes, Optional[ContentType]]

Encodes a message.

PARAMETER DESCRIPTION
msg

The message to be encoded.

TYPE: Union[Sequence[SendableMessage], SendableMessage]

RETURNS DESCRIPTION
Tuple[bytes, Optional[ContentType]]

A tuple containing the encoded message as bytes and the content type of the message.
Source code in faststream/broker/parsers.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def encode_message(
    msg: Union[Sequence[SendableMessage], SendableMessage],
) -> Tuple[bytes, Optional[ContentType]]:
    """Encodes a message.

    Args:
        msg: The message to be encoded.

    Returns:
        A tuple containing the encoded message as bytes and the content type of the message.

    """
    if msg is None:
        return b"", None

    if isinstance(msg, bytes):
        return msg, None

    if isinstance(msg, str):
        return msg.encode(), ContentTypes.text.value

    return (
        dump_json(msg),
        ContentTypes.json.value,
    )