Struct cpython::GILProtected

pub struct GILProtected<T> { /* private fields */ }

Mutex-like wrapper object for data that is protected by the Python GIL.

Example

use std::cell::Cell;
use cpython::{Python, GILProtected};

let data = GILProtected::new(Cell::new(0));

{
    let gil_guard = Python::acquire_gil();
    let cell = data.get(gil_guard.python());
    cell.set(cell.get() + 1);
}

Implementations

impl<T> GILProtected<T>

pub const fn new(data: T) -> GILProtected<T>

Creates a new instance of GILProtected.

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

Returns a shared reference to the data stored in the GILProtected.

Requires a Python instance as proof that the GIL is acquired.

pub fn into_inner(self) -> T

Consumes the GILProtected, returning the wrapped value.

Trait Implementations

impl<T: Send> Send for GILProtected<T>

impl<T: Send> Sync for GILProtected<T>

Because GILProtected ensures that the contained data is only accessed while the GIL is acquired, it can implement Sync even if the contained data does not.