Struct PyRefMut

#[repr(transparent)]
pub struct PyRefMut<'p, T: PyClass<Frozen = False>> {
    inner: Bound<'p, T>,
}

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

See the module-level documentation for more information.

Fields

inner: Bound<'p, T>

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).

pub(crate) fn borrow(obj: &Bound<'py, T>) -> Self

pub(crate) fn try_borrow(obj: &Bound<'py, T>) -> Result<Self, PyBorrowMutError>

pub(crate) fn downgrade(slf: &Self) -> &PyRef<'py, T>

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.

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 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<T, U> AsRef<U> for PyRefMut<'_, 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<T: PyClass<Frozen = False>> Deref for PyRefMut<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

impl<T: PyClass<Frozen = False>> Drop for PyRefMut<'_, 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 type_input() -> TypeInfo

Available on crate feature experimental-inspect only.

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

impl<'a, 'py, T: PyClass<Frozen = False>> IntoPyObject<'py> for &'a PyRefMut<'py, T>

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<Self::Output, Self::Error>

Performs the conversion.

fn type_output() -> TypeInfo

Available on crate feature experimental-inspect only.

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

#[doc(hidden)] fn owned_sequence_into_pyobject<I>( iter: I, py: Python<'py>, _: Token, ) -> Result<Bound<'py, PyAny>, PyErr>

where I: IntoIterator<Item = Self> + AsRef<[Self]>, I::IntoIter: ExactSizeIterator<Item = Self>,

Converts sequence of Self into a Python object. Used to specialize Vec<u8>, [u8; N] and SmallVec<[u8; N]> as a sequence of bytes into a bytes object.

#[doc(hidden)] fn borrowed_sequence_into_pyobject<I>( iter: I, py: Python<'py>, _: Token, ) -> Result<Bound<'py, PyAny>, PyErr>

where Self: Reference, I: IntoIterator<Item = Self> + AsRef<[<Self as Reference>::BaseType]>, I::IntoIter: ExactSizeIterator<Item = Self>,

Converts sequence of Self into a Python object. Used to specialize &[u8] and Cow<[u8]> as a sequence of bytes into a bytes object.

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

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<Self::Output, Self::Error>

Performs the conversion.

fn type_output() -> TypeInfo

Available on crate feature experimental-inspect only.

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

#[doc(hidden)] fn owned_sequence_into_pyobject<I>( iter: I, py: Python<'py>, _: Token, ) -> Result<Bound<'py, PyAny>, PyErr>

where I: IntoIterator<Item = Self> + AsRef<[Self]>, I::IntoIter: ExactSizeIterator<Item = Self>,

Converts sequence of Self into a Python object. Used to specialize Vec<u8>, [u8; N] and SmallVec<[u8; N]> as a sequence of bytes into a bytes object.

impl<'a, 'py, T: PyClass<Frozen = False>> TryFrom<BoundRef<'a, 'py, T>> for PyRefMut<'py, T>

type Error = PyBorrowMutError

The type returned in the event of a conversion error.

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

Performs the conversion.