pyo3 0.28.3

Bindings to Python interpreter
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

use std::future::Future;

use crate::{
    coroutine::{cancel::ThrowCallback, Coroutine},
    instance::Bound,
    types::PyString,
    Py, PyAny, PyResult, Python,
};

pub fn new_coroutine<'py, F>(
    name: &Bound<'py, PyString>,
    qualname_prefix: Option<&'static str>,
    throw_callback: Option<ThrowCallback>,
    future: F,
) -> Coroutine
where
    F: Future<Output = PyResult<Py<PyAny>>> + Send + 'static,
{
    Coroutine::new(Some(name.clone()), qualname_prefix, throw_callback, future)
}

/// Handle which assumes that the coroutine is attached to the thread. Unlike `Python<'_>`, this is `Send`.
pub struct AssumeAttachedInCoroutine(());

impl AssumeAttachedInCoroutine {
    /// Safety: this should only be used inside a future passed to `new_coroutine`, where the coroutine is
    /// guaranteed to be attached to the thread when polled.
    pub unsafe fn new() -> Self {
        Self(())
    }

    pub fn py(&self) -> Python<'_> {
        // Safety: this type holds the invariant that the thread is attached
        unsafe { Python::assume_attached() }
    }
}