Struct pyo3::Py
[−]
[src]
pub struct Py<T>(pub *mut PyObject, _);
Safe wrapper around unsafe *mut ffi::PyObject
pointer with specified type information.
Methods
impl<T> Py<T>
[src]
pub unsafe fn from_owned_ptr(ptr: *mut PyObject) -> Py<T>
[src]
Creates a Py<T>
instance for the given FFI pointer.
This moves ownership over the pointer into the Py<T>
.
Undefined behavior if the pointer is NULL or invalid.
pub unsafe fn from_owned_ptr_or_panic(ptr: *mut PyObject) -> Py<T>
[src]
Creates a Py<T>
instance for the given FFI pointer.
Panics if the pointer is null
.
Undefined behavior if the pointer is invalid.
pub unsafe fn from_owned_ptr_or_err(
py: Python,
ptr: *mut PyObject
) -> PyResult<Py<T>>
[src]
py: Python,
ptr: *mut PyObject
) -> PyResult<Py<T>>
Construct Py<T>
from the result of a Python FFI call that
returns a new reference (owned pointer).
Returns Err(PyErr)
if the pointer is null
.
Unsafe because the pointer might be invalid.
pub unsafe fn from_borrowed_ptr(ptr: *mut PyObject) -> Py<T>
[src]
Creates a Py<T>
instance for the given Python FFI pointer.
Calls Py_INCREF() on the ptr.
Undefined behavior if the pointer is NULL or invalid.
pub fn get_refcnt(&self) -> isize
[src]
Gets the reference count of the ffi::PyObject pointer.
pub fn clone_ref(&self, _py: Python) -> Py<T>
[src]
Clone self, Calls Py_INCREF() on the ptr.
impl<T> Py<T> where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
pub fn new<F>(py: Python, f: F) -> PyResult<Py<T>> where
F: FnOnce(PyToken) -> T,
T: PyTypeObject + PyTypeInfo,
[src]
F: FnOnce(PyToken) -> T,
T: PyTypeObject + PyTypeInfo,
Create new instance of T and move it under python management
Returns Py<T>
.
pub fn new_ref<F>(py: Python, f: F) -> PyResult<&T> where
F: FnOnce(PyToken) -> T,
T: PyTypeObject + PyTypeInfo,
[src]
F: FnOnce(PyToken) -> T,
T: PyTypeObject + PyTypeInfo,
Create new instance of T
and move it under python management.
Returns references to T
pub fn new_mut<F>(py: Python, f: F) -> PyResult<&mut T> where
F: FnOnce(PyToken) -> T,
T: PyTypeObject + PyTypeInfo,
[src]
F: FnOnce(PyToken) -> T,
T: PyTypeObject + PyTypeInfo,
Create new instance of T
and move it under python management.
Returns mutable references to T
Trait Implementations
impl<T: Debug> Debug for Py<T>
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<T> Send for Py<T>
[src]
impl<T> Sync for Py<T>
[src]
impl<T> AsPyRef<T> for Py<T> where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
fn as_ref(&self, _py: Python) -> &T
[src]
Return reference to object.
fn as_mut(&self, _py: Python) -> &mut T
[src]
Return mutable reference to object.
fn with<F, R>(&self, f: F) -> R where
F: FnOnce(Python, &T) -> R,
[src]
F: FnOnce(Python, &T) -> R,
Acquire python gil and call closure with object reference.
fn with_mut<F, R>(&self, f: F) -> R where
F: FnOnce(Python, &mut T) -> R,
[src]
F: FnOnce(Python, &mut T) -> R,
Acquire python gil and call closure with mutable object reference.
fn into_py<F, R>(self, f: F) -> R where
Self: IntoPyPointer,
F: FnOnce(Python, &T) -> R,
[src]
Self: IntoPyPointer,
F: FnOnce(Python, &T) -> R,
fn into_mut_py<F, R>(self, f: F) -> R where
Self: IntoPyPointer,
F: FnOnce(Python, &mut T) -> R,
[src]
Self: IntoPyPointer,
F: FnOnce(Python, &mut T) -> R,
impl<T> AsPyRef<T> for Py<T> where
T: PyTypeInfo + PyNativeType,
[src]
T: PyTypeInfo + PyNativeType,
fn as_ref(&self, _py: Python) -> &T
[src]
Return reference to object.
fn as_mut(&self, _py: Python) -> &mut T
[src]
Return mutable reference to object.
fn with<F, R>(&self, f: F) -> R where
F: FnOnce(Python, &T) -> R,
[src]
F: FnOnce(Python, &T) -> R,
Acquire python gil and call closure with object reference.
fn with_mut<F, R>(&self, f: F) -> R where
F: FnOnce(Python, &mut T) -> R,
[src]
F: FnOnce(Python, &mut T) -> R,
Acquire python gil and call closure with mutable object reference.
fn into_py<F, R>(self, f: F) -> R where
Self: IntoPyPointer,
F: FnOnce(Python, &T) -> R,
[src]
Self: IntoPyPointer,
F: FnOnce(Python, &T) -> R,
fn into_mut_py<F, R>(self, f: F) -> R where
Self: IntoPyPointer,
F: FnOnce(Python, &mut T) -> R,
[src]
Self: IntoPyPointer,
F: FnOnce(Python, &mut T) -> R,
impl<T> ToPyObject for Py<T>
[src]
impl<T> IntoPyObject for Py<T>
[src]
fn into_object(self, _py: Python) -> PyObject
[src]
Converts Py
instance -> PyObject.
Consumes self
without calling Py_DECREF()
impl<T> ToPyPointer for Py<T>
[src]
impl<T> IntoPyPointer for Py<T>
[src]
impl<T> PartialEq for Py<T>
[src]
fn eq(&self, o: &Py<T>) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl<T> Drop for Py<T>
[src]
Dropping a Py
instance decrements the reference count on the object by 1.
impl<T> From<Py<T>> for PyObject
[src]
impl<'a, T> From<&'a T> for Py<T> where
T: ToPyPointer,
[src]
T: ToPyPointer,
impl<'a, T> From<&'a mut T> for Py<T> where
T: ToPyPointer,
[src]
T: ToPyPointer,
impl<'a, T> FromPyObject<'a> for Py<T> where
T: ToPyPointer,
&'a T: 'a + FromPyObject<'a>,
[src]
T: ToPyPointer,
&'a T: 'a + FromPyObject<'a>,
fn extract(ob: &'a PyObjectRef) -> PyResult<Self>
[src]
Extracts Self
from the source PyObject
.
impl IntoPyDictPointer for Py<PyDict>
[src]
fn into_dict_ptr(self, _py: Python) -> *mut PyObject
[src]
Converts self into a PyDict
object pointer. Whether pointer owned or borrowed depends on implementation. Read more
impl IntoPyTuple for Py<PyTuple>
[src]
fn into_tuple(self, _py: Python) -> Py<PyTuple>
[src]
Converts self into a PyTuple object.