pub struct PyWeakrefProxy(/* private fields */);
Expand description
Represents any Python weakref
Proxy type.
In Python this is created by calling weakref.proxy
.
This is either a weakref.ProxyType
or a weakref.CallableProxyType
(weakref.ProxyTypes
).
Implementations§
Source§impl PyWeakrefProxy
TODO: UPDATE DOCS
impl PyWeakrefProxy
TODO: UPDATE DOCS
Sourcepub fn new_bound<'py>(
object: &Bound<'py, PyAny>,
) -> PyResult<Bound<'py, PyWeakrefProxy>>
pub fn new_bound<'py>( object: &Bound<'py, PyAny>, ) -> PyResult<Bound<'py, PyWeakrefProxy>>
Constructs a new Weak Reference (weakref.proxy
/weakref.ProxyType
/weakref.CallableProxyType
) for the given object.
Returns a TypeError
if object
is not weak referenceable (Most native types and PyClasses without weakref
flag).
§Examples
use pyo3::prelude::*;
use pyo3::types::PyWeakrefProxy;
#[pyclass(weakref)]
struct Foo { /* fields omitted */ }
Python::with_gil(|py| {
let foo = Bound::new(py, Foo {})?;
let weakref = PyWeakrefProxy::new_bound(&foo)?;
assert!(
// In normal situations where a direct `Bound<'py, Foo>` is required use `upgrade::<Foo>`
weakref.upgrade()
.map_or(false, |obj| obj.is(&foo))
);
let weakref2 = PyWeakrefProxy::new_bound(&foo)?;
assert!(weakref.is(&weakref2));
drop(foo);
assert!(weakref.upgrade().is_none());
Ok(())
})
Sourcepub fn new_bound_with<'py, C>(
object: &Bound<'py, PyAny>,
callback: C,
) -> PyResult<Bound<'py, PyWeakrefProxy>>where
C: ToPyObject,
pub fn new_bound_with<'py, C>(
object: &Bound<'py, PyAny>,
callback: C,
) -> PyResult<Bound<'py, PyWeakrefProxy>>where
C: ToPyObject,
Constructs a new Weak Reference (weakref.proxy
/weakref.ProxyType
/weakref.CallableProxyType
) for the given object with a callback.
Returns a TypeError
if object
is not weak referenceable (Most native types and PyClasses without weakref
flag) or if the callback
is not callable or None.
§Examples
use pyo3::prelude::*;
use pyo3::types::PyWeakrefProxy;
#[pyclass(weakref)]
struct Foo { /* fields omitted */ }
#[pyfunction]
fn callback(wref: Bound<'_, PyWeakrefProxy>) -> PyResult<()> {
let py = wref.py();
assert!(wref.upgrade_as::<Foo>()?.is_none());
py.run_bound("counter = 1", None, None)
}
Python::with_gil(|py| {
py.run_bound("counter = 0", None, None)?;
assert_eq!(py.eval_bound("counter", None, None)?.extract::<u32>()?, 0);
let foo = Bound::new(py, Foo{})?;
// This is fine.
let weakref = PyWeakrefProxy::new_bound_with(&foo, py.None())?;
assert!(weakref.upgrade_as::<Foo>()?.is_some());
assert!(
// In normal situations where a direct `Bound<'py, Foo>` is required use `upgrade::<Foo>`
weakref.upgrade()
.map_or(false, |obj| obj.is(&foo))
);
assert_eq!(py.eval_bound("counter", None, None)?.extract::<u32>()?, 0);
let weakref2 = PyWeakrefProxy::new_bound_with(&foo, wrap_pyfunction_bound!(callback, py)?)?;
assert!(!weakref.is(&weakref2)); // Not the same weakref
assert!(weakref.eq(&weakref2)?); // But Equal, since they point to the same object
drop(foo);
assert!(weakref.upgrade_as::<Foo>()?.is_none());
assert_eq!(py.eval_bound("counter", None, None)?.extract::<u32>()?, 1);
Ok(())
})
Trait Implementations§
Source§impl AsPyPointer for PyWeakrefProxy
impl AsPyPointer for PyWeakrefProxy
Source§impl AsRef<PyAny> for PyWeakrefProxy
impl AsRef<PyAny> for PyWeakrefProxy
Source§impl Deref for PyWeakrefProxy
impl Deref for PyWeakrefProxy
Source§impl PyTypeCheck for PyWeakrefProxy
impl PyTypeCheck for PyWeakrefProxy
impl DerefToPyAny for PyWeakrefProxy
Auto Trait Implementations§
impl !Freeze for PyWeakrefProxy
impl !RefUnwindSafe for PyWeakrefProxy
impl !Send for PyWeakrefProxy
impl !Sync for PyWeakrefProxy
impl Unpin for PyWeakrefProxy
impl UnwindSafe for PyWeakrefProxy
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more