Struct PyRefMut

pub struct PyRefMut<'p, T>
where
    T: PyClass<Frozen = False>,
{ /* private fields */ }

Available on crate features dep_pyo3 and std only.

A wrapper type for a mutably borrowed value from a [Bound<'py, T>].

See the module-level documentation for more information.

Implementations

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

where T: PyClass<Frozen = False>,

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

Returns a Python token that is bound to the lifetime of the PyRefMut.

impl<'py, T> PyRefMut<'py, T>

where T: PyClass<Frozen = False>,

pub fn as_ptr(&self) -> *mut PyObject

Returns the raw FFI pointer represented by self.

Safety

Callers are responsible for ensuring that the pointer does not outlive self.

The reference is borrowed; callers should not decrease the reference count when they are finished with the pointer.

pub fn into_ptr(self) -> *mut PyObject

Returns an owned raw FFI pointer represented by self.

Safety

The reference is owned; when finished the caller should either transfer ownership of the pointer or decrease the reference count (e.g. with pyo3::ffi::Py_DecRef).

impl<'p, T, U> PyRefMut<'p, T>

where U: PyClass<Frozen = False>, T: PyClass<BaseType = U, Frozen = False>,

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

Gets a PyRef<T::BaseType>.

See PyRef::into_super for more.

pub fn as_super(&mut self) -> &mut PyRefMut<'p, U>

Borrows a mutable reference to PyRefMut<T::BaseType>.

With the help of this method, you can mutate attributes and call mutating methods on the superclass without consuming the PyRefMut<T>. This method can also be chained to access the super-superclass (and so on).

See PyRef::as_super for more.

Trait Implementations

impl<T, U> AsMut<U> for PyRefMut<'_, T>

where U: PyClass<Frozen = False>, T: PyClass<BaseType = U, Frozen = False>,

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

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

impl<T, U> AsRef<U> for PyRefMut<'_, T>

where U: PyClass<Frozen = False>, T: PyClass<BaseType = U, Frozen = False>,

fn as_ref(&self) -> &<T as PyClassImpl>::BaseType

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

impl<T> Debug for PyRefMut<'_, T>

where T: PyClass<Frozen = False> + Debug,

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

Formats the value using the given formatter.

impl<T> Deref for PyRefMut<'_, T>

where T: PyClass<Frozen = False>,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for PyRefMut<'_, T>

where T: PyClass<Frozen = False>,

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

Mutably dereferences the value.

impl<T> Drop for PyRefMut<'_, T>

where T: PyClass<Frozen = False>,

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> From<PyRefMut<'a, T>> for Py<T>

where T: PyClass<Frozen = False>,

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

Converts to this type from the input type.

impl<'py, T> FromPyObject<'py> for PyRefMut<'py, T>

where T: PyClass<Frozen = False>,

fn extract_bound(obj: &Bound<'py, PyAny>) -> Result<PyRefMut<'py, T>, PyErr>

Extracts Self from the bound smart pointer obj.

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

where T: PyClass<Frozen = False>,

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

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

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

where T: PyClass<Frozen = False>,

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

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'a, 'py, T> IntoPyObject<'py> for &'a PyRefMut<'py, T>

where T: PyClass<Frozen = False>,

type Target = T

The Python output type

type Output = Borrowed<'a, 'py, T>

The smart pointer type to use.

type Error = Infallible

The type returned in the event of a conversion error.

fn into_pyobject( self, _py: Python<'py>, ) -> Result<<&'a PyRefMut<'py, T> as IntoPyObject<'py>>::Output, <&'a PyRefMut<'py, T> as IntoPyObject<'py>>::Error>

Performs the conversion.

impl<'py, T> IntoPyObject<'py> for PyRefMut<'py, T>

where T: PyClass<Frozen = False>,

type Target = T

The Python output type

type Output = Bound<'py, T>

The smart pointer type to use.

type Error = Infallible

The type returned in the event of a conversion error.

fn into_pyobject( self, _py: Python<'py>, ) -> Result<<PyRefMut<'py, T> as IntoPyObject<'py>>::Output, <PyRefMut<'py, T> as IntoPyObject<'py>>::Error>

Performs the conversion.

impl<'a, 'py, T> TryFrom<BoundRef<'a, 'py, T>> for PyRefMut<'py, T>

where T: PyClass<Frozen = False>,

type Error = PyBorrowMutError

The type returned in the event of a conversion error.

fn try_from( value: BoundRef<'a, 'py, T>, ) -> Result<PyRefMut<'py, T>, <PyRefMut<'py, T> as TryFrom<BoundRef<'a, 'py, T>>>::Error>

Performs the conversion.