Struct pyo3::types::function::PyCFunction

#[repr(transparent)]
pub struct PyCFunction(PyAny);

Represents a builtin Python function object.

Tuple Fields

0: PyAny

Implementations

impl PyCFunction

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

impl PyCFunction

pub fn new_with_keywords_bound<'py>( py: Python<'py>, fun: PyCFunctionWithKeywords, name: &'static str, doc: &'static str, module: Option<&Bound<'py, PyModule>> ) -> PyResult<Bound<'py, Self>>

Create a new built-in function with keywords (*args and/or **kwargs).

pub fn new_bound<'py>( py: Python<'py>, fun: PyCFunction, name: &'static str, doc: &'static str, module: Option<&Bound<'py, PyModule>> ) -> PyResult<Bound<'py, Self>>

Create a new built-in function which takes no arguments.

pub fn new_closure_bound<'py, F, R>( py: Python<'py>, name: Option<&'static str>, doc: Option<&'static str>, closure: F ) -> PyResult<Bound<'py, Self>>

where F: Fn(&Bound<'_, PyTuple>, Option<&Bound<'_, PyDict>>) -> R + Send + 'static, R: IntoPyCallbackOutput<*mut PyObject>,

Create a new function from a closure.

Examples

Python::with_gil(|py| {
    let add_one = |args: &Bound<'_, PyTuple>, _kwargs: Option<&Bound<'_, PyDict>>| -> PyResult<_> {
        let i = args.extract::<(i64,)>()?.0;
        Ok(i+1)
    };
    let add_one = PyCFunction::new_closure_bound(py, None, None, add_one).unwrap();
    py_run!(py, add_one, "assert add_one(42) == 43");
});

#[doc(hidden)] pub fn internal_new<'py>( py: Python<'py>, method_def: &PyMethodDef, module: Option<&Bound<'py, PyModule>> ) -> PyResult<Bound<'py, Self>>

Methods from Deref<Target = PyAny>

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations

impl AsPyPointer for PyCFunction

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyCFunction

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyCFunction

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeInfo for PyCFunction

const NAME: &'static str = "PyCFunction"

Available on non-crate feature gil-refs only.

Class name.

const MODULE: Option<&'static str> = _

Available on non-crate feature gil-refs only.

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Available on non-crate feature gil-refs only.

Returns the PyTypeObject instance for this type.

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

Available on non-crate feature gil-refs only.

Checks if object is an instance of this type or a subclass of this type.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Available on non-crate feature gil-refs only.

Returns the safe abstraction over the type object.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Available on non-crate feature gil-refs only.

Checks if object is an instance of this type.

impl DerefToPyAny for PyCFunction