Struct GILProtected

pub struct GILProtected<T> {
    value: T,
}

Available on non-Py_GIL_DISABLED only.

Value with concurrent access protected by the GIL.

This is a synchronization primitive based on Python’s global interpreter lock (GIL). It ensures that only one thread at a time can access the inner value via shared references. It can be combined with interior mutability to obtain mutable references.

This type is not defined for extensions built against the free-threaded CPython ABI.

Example

Combining GILProtected with RefCell enables mutable access to static data:

use pyo3::sync::GILProtected;
use std::cell::RefCell;

static NUMBERS: GILProtected<RefCell<Vec<i32>>> = GILProtected::new(RefCell::new(Vec::new()));

Python::with_gil(|py| {
    NUMBERS.get(py).borrow_mut().push(42);
});

Fields

value: T

Implementations

impl<T> GILProtected<T>

pub const fn new(value: T) -> Self

Place the given value under the protection of the GIL.

pub fn get<'py>(&'py self, _py: Python<'py>) -> &'py T

Gain access to the inner value by giving proof of having acquired the GIL.

pub fn traverse<'py>(&'py self, _visit: PyVisit<'py>) -> &'py T

Gain access to the inner value by giving proof that garbage collection is happening.

Trait Implementations

impl<T> Sync for GILProtected<T>

where T: Send,