Struct PyHandle 

pub struct PyHandle { /* private fields */ }

The observe-only handle to a background Tokio task or Python-owned operation.

Exposed to Python as monarch._rust_bindings.monarch_hyperactor.handle.Handle. HDL-11: Python cannot construct one directly. Internal Python may obtain one only from the private _new_handle_pair() factory together with its sole producer.

Implementations

impl PyHandle

pub fn from_value(value: Py<PyAny>) -> PyResult<Self>

Construct an already-complete Handle from value without spawning a producer task (HDL-15).

Rust-only and outside #[pymethods], so making this method public does not make Handle directly constructible from Python (HDL-11).

pub fn wait_future( &self, ) -> impl Future<Output = PyResult<Py<PyAny>>> + Send + 'static + use<>

Return an owned, non-consuming Rust observer for this Handle’s value (HDL-14).

The returned future owns a cloned watch receiver, so it borrows nothing from self, survives the PyHandle being dropped, and can coexist with any number of other observers.

pub fn spawn<F, T>(fut: F) -> Self

where F: Future<Output = PyResult<T>> + Send + 'static, T: for<'py> IntoPyObject<'py> + Send,

Eagerly drive a Rust future to completion and return an observe-only Handle over its result (HDL-13).

The producer spawns immediately on the shared Tokio runtime; the returned Handle observes already-running work rather than starting it lazily on first observation. On completion the terminal PyResult<T> is converted to Py<PyAny> under monarch_with_gil and published exactly once through the shared send_result helper (HDL-1/HDL-2). The core carries abort_on_drop: None, so dropping the Handle never cancels the producer (HDL-4). Rust-only and outside #[pymethods], so Python still cannot mint a core (HDL-11).

pub fn wait_completion( &self, ) -> impl Future<Output = PyResult<()>> + Send + 'static + use<>

Observe whether this handle completed successfully, projecting the terminal value to PyResult<()> (HDL-13).

Returns an owned Send + 'static future over a cloned receiver (HDL-9), so multiple Rust callers can observe the same terminal state and dropping the Handle after taking an observer does not abort the producer (HDL-4). The ready-success fast path touches neither the GIL nor the Python value (a discriminant-only read, HDL-3); only the error path clones the stored PyErr. This is the readiness surface for callers that need only the success/error discriminant, not the value.

Trait Implementations

impl DerefToPyAny for PyHandle

impl ExtractPyClassWithClone for PyHandle

impl<'py> IntoPyObject<'py> for PyHandle

type Target = PyHandle

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyHandle

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 = /// The observe-only handle to a background Tokio task or Python-owned operation. /// /// Exposed to Python as /// `monarch._rust_bindings.monarch_hyperactor.handle.Handle`. HDL-11: Python /// cannot construct one directly. Internal Python may obtain one only from the /// private `_new_handle_pair()` factory together with its sole producer.

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

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPyHandle

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 PyTypeInfo for PyHandle

const NAME: &'static str = "Handle"

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.