Struct PyShared 

pub struct PyShared { /* private fields */ }

Awaitable handle to a spawned background Tokio task.

Shared is returned by PythonTask.spawn() / spawn_abortable(). It carries a watch receiver that is fulfilled exactly once with the task’s PyResult<Py<PyAny>>.

Usage:

• await shared inside the PythonTask.from_coroutine(...) world, or
• shared.block_on() to wait synchronously.

If abort is true (from spawn_abortable()), dropping this object aborts the underlying Tokio task via its JoinHandle.

Implementations

impl PyShared

pub fn block_on(slf: PyRef<'_, PyShared>, py: Python<'_>) -> PyResult<Py<PyAny>>

Wait synchronously for this Shared to resolve.

This blocks the calling Python thread until the underlying background task has published its result into the watch channel, then returns that Py<PyAny> (or raises the stored Python exception).

If the value is already available, returns immediately without blocking. This is important for cases where block_on is called from within a tokio runtime (e.g., during unpickling on a worker thread) - we can’t call runtime.block_on() from within a runtime.

Trait Implementations

impl Drop for PyShared

If this Shared was created via spawn_abortable(), abort the underlying Tokio task on drop.

This prevents abandoned background work from running forever when no receivers remain. We guard against panics during interpreter shutdown / runtime teardown.

fn drop(&mut self)

Executes the destructor for this type.

impl<'py> IntoPyObject<'py> for PyShared

type Target = PyShared

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyShared

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 = /// Awaitable handle to a spawned background Tokio task. /// /// `Shared` is returned by `PythonTask.spawn()` / /// `spawn_abortable()`. It carries a `watch` receiver that is /// fulfilled exactly once with the task's `PyResult<Py<PyAny>>`. /// /// Usage: /// - `await shared` inside the `PythonTask.from_coroutine(...)` /// world, or /// - `shared.block_on()` to wait synchronously. /// /// If `abort` is true (from `spawn_abortable()`), dropping this /// object aborts the underlying Tokio task via its `JoinHandle`.

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

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPyShared

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<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PyShared

type Holder = Option<PyClassGuard<'a, PyShared>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut PyShared

type Holder = Option<PyClassGuardMut<'a, PyShared>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyTypeInfo for PyShared

const NAME: &'static str = "Shared"

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.

impl DerefToPyAny for PyShared