Struct pyo3::gil::GILGuard

pub struct GILGuard {
    gstate: PyGILState_STATE,
    pool: ManuallyDrop<Option<GILPool>>,
    _not_send: NotSend,
}

RAII type that represents the Global Interpreter Lock acquisition.

Users are strongly encouraged to use Python::with_gil instead of directly constructing this type. See Python::acquire_gil for more.

Examples

use pyo3::Python;

{
    let gil_guard = Python::acquire_gil();
    let py = gil_guard.python();
} // GIL is released when gil_guard is dropped

Fields

gstate: PyGILState_STATE

pool: ManuallyDrop<Option<GILPool>>

_not_send: NotSend

Implementations

impl GILGuard

pub fn python(&self) -> Python<'_>

Retrieves the marker type that proves that the GIL was acquired.

pub(crate) fn acquire() -> GILGuard

PyO3 internal API for acquiring the GIL. The public API is Python::acquire_gil.

If PyO3 does not yet have a GILPool for tracking owned PyObject references, then this new GILGuard will also contain a GILPool.

pub(crate) fn acquire_unchecked() -> GILGuard

Acquires the GILGuard without performing any state checking.

This can be called in “unsafe” contexts where the normal interpreter state checking performed by GILGuard::acquire may fail. This includes calling as part of multi-phase interpreter initialization.

Trait Implementations

impl Drop for GILGuard

The Drop implementation for GILGuard will release the GIL.

fn drop(&mut self)

Executes the destructor for this type.