Struct pyo3::PyRefMut

pub struct PyRefMut<'a, T: PyTypeInfo>(_, _);

Mutable version of PyRef.

Example

use pyo3::prelude::*;
use pyo3::types::IntoPyDict;
#[pyclass]
struct Point {
    x: i32,
    y: i32,
}
#[pymethods]
impl Point {
    fn length(&self) -> i32 {
        self.x * self.y
    }
}
let gil = Python::acquire_gil();
let py = gil.python();
let mut obj = PyRefMut::new(gil.python(), Point { x: 3, y: 4 }).unwrap();
let d = vec![("p", obj.to_object(py))].into_py_dict(py);
obj.x = 5; obj.y = 20;
py.run("assert p.length() == 100", None, Some(d)).unwrap();

Methods

impl<'p, T> PyRefMut<'p, T> where
    T: PyTypeInfo + PyTypeObject + PyTypeCreate, 

pub fn new(py: Python<'p>, value: T) -> PyResult<PyRefMut<T>>

Trait Implementations

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

fn as_ptr(&self) -> *mut PyObject

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

impl<'a, T: PyTypeInfo> ToPyObject for PyRefMut<'a, T>

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.

impl<'p, T> FromPyPointer<'p> for PyRefMut<'p, T> where
    T: PyTypeInfo, 

unsafe fn from_owned_ptr_or_opt(
    py: Python<'p>,
    ptr: *mut PyObject
) -> Option<Self>

unsafe fn from_borrowed_ptr_or_opt(
    py: Python<'p>,
    ptr: *mut PyObject
) -> Option<Self>

unsafe fn from_owned_ptr_or_panic(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_owned_ptr_or_err(
    py: Python<'p>,
    ptr: *mut PyObject
) -> PyResult<Self>

unsafe fn from_borrowed_ptr_or_panic(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_borrowed_ptr(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_borrowed_ptr_or_err(
    py: Python<'p>,
    ptr: *mut PyObject
) -> PyResult<Self>

impl<'a, T> From<PyRefMut<'a, T>> for Py<T> where
    T: PyTypeInfo, 

fn from(ob: PyRefMut<'a, T>) -> Self

Performs the conversion.

impl<'a, T> From<PyRefMut<'a, T>> for &'a PyAny where
    T: PyTypeInfo, 

fn from(pref: PyRefMut<'a, T>) -> &'a PyAny

Performs the conversion.

impl<'a, T: PyTypeInfo> DerefMut for PyRefMut<'a, T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'a, T: PyTypeInfo> Deref for PyRefMut<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: Debug + PyTypeInfo> Debug for PyRefMut<'a, T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.