Enum GILGuard

pub(crate) enum GILGuard {
    Assumed,
    Ensured {
        gstate: PyGILState_STATE,
    },
}

RAII type that represents the Global Interpreter Lock acquisition.

Variants

Assumed

Indicates the GIL was already held with this GILGuard was acquired.

Ensured

Indicates that we actually acquired the GIL when this GILGuard was acquired

Fields

gstate: PyGILState_STATE

Implementations

impl GILGuard

pub(crate) fn acquire() -> 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 GILGuard::Assumed. Otherwise, the GIL will be acquired and GILGuard::Ensured will be returned.

pub(crate) unsafe fn acquire_unchecked() -> 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.

pub(crate) unsafe fn assume() -> Self

Acquires the GILGuard while assuming that the GIL is already held.

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

Gets the Python token associated with this GILGuard.

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.