Struct BusMessage 

pub struct BusMessage {
    pub topic: Ustr,
    pub payload_type: BusPayloadType,
    pub payload: Bytes,
    pub encoding: SerializationEncoding,
}

Represents a bus message including a topic and serialized payload.

Control messages (such as CLOSE) that carry no typed payload use an empty BusPayloadType::Custom.

Fields

topic: Ustr

The topic to publish the message on.

payload_type: BusPayloadType

The payload type, carried out-of-band so the receiver can dispatch the serialized payload without parsing the topic or inspecting the bytes.

payload: Bytes

The serialized payload for the message.

encoding: SerializationEncoding

The encoding the payload is serialized with, so the receiver can decode it without relying on its own configuration (mirrors a wire content-type).

Implementations

impl BusMessage

pub fn new( topic: Ustr, payload_type: BusPayloadType, payload: Bytes, encoding: SerializationEncoding, ) -> Self

Creates a new BusMessage instance.

pub fn with_str_topic<T: AsRef<str>>( topic: T, payload_type: BusPayloadType, payload: Bytes, encoding: SerializationEncoding, ) -> Self

Creates a new BusMessage instance with a string-like topic.

This is a convenience constructor that converts any string-like type (implementing AsRef<str>) into the required Ustr type.

pub fn new_close() -> Self

Creates a new BusMessage instance with the CLOSE topic and empty payload.

Trait Implementations

impl Clone for BusMessage

fn clone(&self) -> BusMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BusMessage

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

Formats the value using the given formatter.

impl DerefToPyAny for BusMessage

impl<'de> Deserialize<'de> for BusMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BusMessage

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

Formats the value using the given formatter.

impl<'a, 'py> FromPyObject<'a, 'py> for BusMessage

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for BusMessage

type Target = BusMessage

The Python output type

type Output = Bound<'py, <BusMessage as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for BusMessage

const NAME: &str = "BusMessage"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BusMessage

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents a bus message including a topic and serialized payload. /// /// Control messages (such as `CLOSE`) that carry no typed payload use an empty /// [`BusPayloadType::Custom`].

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<BusMessage as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<BusMessage>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForBusMessage

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyStubType for BusMessage

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for BusMessage

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for BusMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.