Trait PyFunctionArgument

pub trait PyFunctionArgument<'a, 'py, const IS_OPTION: bool>: Sized + 'a {
    type Holder: FunctionArgumentHolder;

    const INPUT_TYPE: &'static str;

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

A trait which is used to help PyO3 macros extract function arguments.

#[pyclass] structs need to extract as PyRef<T> and PyRefMut<T> wrappers rather than extracting &T and &mut T directly. The Holder type is used to hold these temporary wrappers - the way the macro is constructed, these wrappers will be dropped as soon as the pyfunction call ends.

There exists a trivial blanket implementation for T: FromPyObject with Holder = ().

Required Associated Constants

const INPUT_TYPE: &'static str

Available on crate feature experimental-inspect only.

Provides the type hint information for which Python types are allowed.

Required Associated Types

type Holder: FunctionArgumentHolder

Required Methods

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

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<'a, 'py, T> PyFunctionArgument<'a, 'py, true> for Option<T>

where T: PyFunctionArgument<'a, 'py, false>,

const INPUT_TYPE: &'static str = "typing.Any | None"

Available on crate feature experimental-inspect only.

type Holder = <T as PyFunctionArgument<'a, 'py, false>>::Holder

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

Implementors

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a Coroutine

Available on crate feature experimental-async only.

const INPUT_TYPE: &'static str = "Coroutine"

type Holder = Option<PyRef<'py, Coroutine>>

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

Available on crate feature experimental-async only.

const INPUT_TYPE: &'static str = "Coroutine"

type Holder = Option<PyRefMut<'py, Coroutine>>

impl<'a, 'py, T> PyFunctionArgument<'a, 'py, false> for &'a Bound<'py, T>

where T: PyTypeCheck + 'py,

const INPUT_TYPE: &'static str = T::PYTHON_TYPE

type Holder = ()

impl<'a, 'py, T> PyFunctionArgument<'a, 'py, false> for T

where T: FromPyObjectBound<'a, 'py> + 'a,

const INPUT_TYPE: &'static str = T::INPUT_TYPE

type Holder = ()