Trait pyo3::conversion::AsPyPointer

pub trait AsPyPointer {
    fn as_ptr(&self) -> *mut PyObject;
}

This trait represents that we can do zero-cost conversion from the object to a FFI pointer.

This trait is implemented for types that internally wrap a pointer to a Python object.

Example

use pyo3::{AsPyPointer, prelude::*};
let gil = Python::acquire_gil();
let dict = pyo3::types::PyDict::new(gil.python());
// All native object wrappers implement AsPyPointer!!!
assert_ne!(dict.as_ptr(), std::ptr::null_mut());

Required methods

fn as_ptr(&self) -> *mut PyObject

Retrieves the underlying FFI pointer (as a borrowed pointer).

Loading content...

Implementations on Foreign Types

impl<T> AsPyPointer for Option<T> where
    T: AsPyPointer, 

Convert None into a null pointer.

fn as_ptr(&self) -> *mut PyObject

Loading content...

Implementors

impl AsPyPointer for PyModule

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyAny

fn as_ptr(&self) -> *mut PyObject

impl AsPyPointer for PyObject

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyBool

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyByteArray

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyBytes

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyComplex

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyDate

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyDateTime

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyDelta

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyDict

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyFloat

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyFrozenSet

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyList

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyLong

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PySequence

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PySet

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PySlice

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyString

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyTime

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyTuple

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyType

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyPointer for PyTzInfo

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl<'a, T: PyClass> AsPyPointer for PyRef<'a, T>

fn as_ptr(&self) -> *mut PyObject

impl<'a, T: PyClass> AsPyPointer for PyRefMut<'a, T>

fn as_ptr(&self) -> *mut PyObject

impl<'p, T: ToPyObject> AsPyPointer for ManagedPyRef<'p, T>

fn as_ptr(&self) -> *mut PyObject

impl<T> AsPyPointer for Py<T>

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl<T: PyClass> AsPyPointer for PyCell<T>

fn as_ptr(&self) -> *mut PyObject

Loading content...