Struct pyo3::pycell::PyRefMut

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

A wrapper type for a mutably borrowed value from aPyCell<T>.

See the module-level documentation for more information.

Implementations

impl<'p, T: PyClass<Frozen = False>> PyRefMut<'p, T>

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

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

impl<'py, T: PyClass<Frozen = False>> PyRefMut<'py, T>

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 T: PyClass<BaseType = U, Frozen = False>, U: PyClass<Frozen = False>,

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

Gets a PyRef<T::BaseType>.

See PyRef::into_super for more.

Trait Implementations

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

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

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

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

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

fn as_ptr(&self) -> *mut PyObject

Returns the underlying FFI pointer as a borrowed pointer.

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

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

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

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

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

impl<'p, T: PyClass<Frozen = False>> 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<Frozen = False>,

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

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>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

fn extract(ob: &'py PyAny) -> PyResult<Self>

Extracts Self from the source GIL Ref obj.

fn type_input() -> TypeInfo

Extracts the type hint information for this type when it appears as an argument.

impl<T: PyClass<Frozen = False>> IntoPy<Py<PyAny>> for &PyRefMut<'_, T>

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

Performs the conversion.

fn type_output() -> TypeInfo

Extracts the type hint information for this type when it appears as a return value.

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

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

Performs the conversion.

fn type_output() -> TypeInfo

Extracts the type hint information for this type when it appears as a return value.

impl<'a, T: PyClass<Frozen = False>> 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.