Struct PendingMessage 

pub struct PendingMessage { /* private fields */ }

A message whose reserved mesh slots must be filled before it can be sent.

Contains a PythonMessageKind and a PicklingState. The PicklingState may hold mesh slots reserved for pending meshes, filled sender-side once their handles resolve, before the message can be converted into a PythonMessage.

Implementations

impl PendingMessage

pub fn new(kind: PythonMessageKind, state: PicklingState) -> Self

Create a new PendingMessage from a kind and pickling state.

pub fn take(&mut self) -> PyResult<PendingMessage>

Take ownership of the inner state from a mutable reference.

This is used by pyo3 pymethods that receive &mut PendingMessage but need to pass ownership to the trait method.

pub fn try_resolve_now(self) -> PyResult<Result<PythonMessage, PendingMessage>>

Convert this message synchronously when no mesh fills are pending.

A pending message is returned unchanged in the inner Err so the caller can use the existing asynchronous resolution path. Every reserved None mesh slot is created together with one pending fill entry, while resolved and reconstructed slots are always Some. Therefore a fresh zero-fill message cannot fail assembly due to an unfilled slot.

pub async fn resolve(self) -> PyResult<PythonMessage>

Resolve any reserved mesh slots and convert this into a PythonMessage.

This is an async method that:

1. Fills the reserved mesh slots from their pending handles
2. Builds a PythonMessage with the resolved bytes and refs table

impl PendingMessage

pub fn py_new( kind: PythonMessageKind, state: PyRefMut<'_, PicklingState>, ) -> PyResult<Self>

Create a new PendingMessage from a kind and pickling state.

Trait Implementations

impl DerefToPyAny for PendingMessage

impl ExtractPyClassWithClone for PendingMessage

impl<'py> IntoPyObject<'py> for PendingMessage

type Target = PendingMessage

The Python output type

type Output = Bound<'py, <PendingMessage 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 PendingMessage

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PendingMessage

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 = /// A message whose reserved mesh slots must be filled before it can be sent. /// /// Contains a `PythonMessageKind` and a `PicklingState`. The `PicklingState` may /// hold mesh slots reserved for pending meshes, filled sender-side once their /// handles resolve, before the message can be converted into a `PythonMessage`.

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 BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PendingMessage>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPendingMessage

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<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for PendingMessage

const TEXT_SIGNATURE: &'static str = "(kind, state)"

impl PyTypeInfo for PendingMessage

const NAME: &'static str = "PendingMessage"

Class name.

const MODULE: Option<&'static str>

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.