Struct pyo3::gil::GILGuard

pub(crate) struct GILGuard {
    gstate: PyGILState_STATE,
    pool: ManuallyDrop<GILPool>,
}

RAII type that represents the Global Interpreter Lock acquisition.

Fields

gstate: PyGILState_STATE

pool: ManuallyDrop<GILPool>

Implementations

impl GILGuard

pub(crate) fn acquire() -> Option<Self>

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

If the GIL was already acquired via PyO3, this returns None. Otherwise, the GIL will be acquired and a new GILPool created.

pub(crate) fn acquire_unchecked() -> Option<Self>

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.