Struct pyo3::pycell::PyRefMut

pub struct PyRefMut<'p, T: PyClass> { /* fields omitted */ }

Wraps a mutable borrowed reference to a value in a PyCell<T>.

See the PyCell and PyRef documentations for more.

Implementations

impl<'p, T: PyClass> PyRefMut<'p, T>

pub fn py(&self) -> Python<'_>

Returns Python token. This function is safe since PyRefMut has the same lifetime as a GILGuard.

impl<'p, T, U> PyRefMut<'p, T> where
    T: PyClass + PyTypeInfo<BaseType = U, BaseLayout = PyCellInner<U>>,
    U: PyClass, 

pub fn into_super(self) -> PyRefMut<'p, U>

Get PyRef<T::BaseType>. See PyRef::into_super for more.

Trait Implementations

impl<'p, T, U> AsMut<U> for PyRefMut<'p, T> where
    T: PyClass + PyTypeInfo<BaseType = U, BaseLayout = PyCellInner<U>>,
    U: PyClass, 

fn as_mut(&mut self) -> &mut T::BaseType

Performs the conversion.

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

fn as_ptr(&self) -> *mut PyObject

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

impl<'p, T, U> AsRef<U> for PyRefMut<'p, T> where
    T: PyClass + PyTypeInfo<BaseType = U, BaseLayout = PyCellInner<U>>,
    U: PyClass, 

fn as_ref(&self) -> &T::BaseType

Performs the conversion.

impl<T: PyClass + Debug> Debug for PyRefMut<'_, T>

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

Formats the value using the given formatter.

impl<'p, T: PyClass> Deref for PyRefMut<'p, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'p, T: PyClass> DerefMut for PyRefMut<'p, T>

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

Mutably dereferences the value.

impl<'p, T: PyClass> Drop for PyRefMut<'p, T>

fn drop(&mut self)

Executes the destructor for this type.

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

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

Performs the conversion.

impl<'a, T> FromPyObject<'a> for PyRefMut<'a, T> where
    T: PyClass, 

fn extract(obj: &'a PyAny) -> PyResult<Self>

Extracts Self from the source PyObject.

impl<T: PyClass> IntoPy<Py<PyAny>> for PyRefMut<'_, T>

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<'a, T: PyClass> TryFrom<&'a PyCell<T>> for PyRefMut<'a, T>

type Error = PyBorrowMutError

The type returned in the event of a conversion error.

fn try_from(cell: &'a PyCell<T>) -> Result<Self, Self::Error>

Performs the conversion.