PyRefMut

timecat

Struct PyRefMut 

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

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

See the module-level documentation for more information.

Implementations§

Source§

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

Source

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

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

Source§

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

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

Source

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

Gets a PyRef<T::BaseType>.

See PyRef::into_super for more.

Source

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§

Source§

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

Source§

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

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

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

Source§

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

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

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

Source§

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

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

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

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

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

Source§

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

Mutably dereferences the value.
Source§

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

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>) -> Py<T>

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_bound(obj: &Bound<'py, PyAny>) -> Result<PyRefMut<'py, T>, PyErr>

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

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

Source§

type Target = T

The Python output type
Source§

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

The smart pointer type to use. Read more
Source§

type Error = Infallible

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

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

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

Source§

type Target = T

The Python output type
Source§

type Output = Bound<'py, T>

The smart pointer type to use. Read more
Source§

type Error = Infallible

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

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

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

Source§

type Error = PyBorrowMutError

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

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.

Auto Trait Implementations§

§

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

§

impl<'p, T> RefUnwindSafe for PyRefMut<'p, T>
where T: RefUnwindSafe,

§

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

§

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

§

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

§

impl<'p, T> UnwindSafe for PyRefMut<'p, T>
where T: UnwindSafe,

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<'py, T> FromPyObjectBound<'_, 'py> for T
where T: FromPyObject<'py>,

Source§

fn from_py_object_bound(ob: Borrowed<'_, 'py, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

Source§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
Source§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
Source§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

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

Source§

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>,

Source§

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.