Struct pyo3::pycell::PyRefMut

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

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

See the module-level documentation for more information.

Implementations§

source§

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

source

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

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

source§

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

source

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.

source

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

source§

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

source

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

Gets a PyRef<T::BaseType>.

See PyRef::into_super for more.

Trait Implementations§

source§

impl<'p, T, U> AsMut<U> for PyRefMut<'p, T>
where T: PyClass<BaseType = U, Frozen = False>, U: PyClass<Frozen = False>,

source§

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

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

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

source§

fn as_ptr(&self) -> *mut PyObject

Returns the underlying FFI pointer as a borrowed pointer.
source§

impl<'p, T, U> AsRef<U> for PyRefMut<'p, T>
where T: PyClass<BaseType = U, Frozen = False>, U: PyClass<Frozen = False>,

source§

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

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

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

source§

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

Formats the value using the given formatter. Read more
source§

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

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

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

source§

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

Mutably dereferences the value.
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Extracts Self from the source GIL Ref obj. Read more
source§

fn extract_bound(ob: &Bound<'py, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj. Read more
source§

fn type_input() -> TypeInfo

Extracts the type hint information for this type when it appears as an argument. Read more
source§

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

source§

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

Performs the conversion.
source§

fn type_output() -> TypeInfo

Extracts the type hint information for this type when it appears as a return value. Read more
source§

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

source§

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

Performs the conversion.
source§

fn type_output() -> TypeInfo

Extracts the type hint information for this type when it appears as a return value. Read more
source§

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.
source§

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

Performs the conversion.

Auto Trait Implementations§

§

impl<'p, T> !RefUnwindSafe for PyRefMut<'p, T>

§

impl<'p, T> !Send for PyRefMut<'p, T>

§

impl<'p, T> !Sync for PyRefMut<'p, T>

§

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

§

impl<'p, T> !UnwindSafe for PyRefMut<'p, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.