Struct pyo3::prelude::GILGuard

#[must_use]pub struct GILGuard { /* fields omitted */ }

RAII type that represents the Global Interpreter Lock acquisition.

Example

use pyo3::Python;

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

Implementations

impl GILGuard

pub fn acquire() -> GILGuard

Acquires the global interpreter lock, which allows access to the Python runtime. This is safe to call multiple times without causing a deadlock.

If the Python runtime is not already initialized, this function will initialize it. See prepare_freethreaded_python() for details.

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

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

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

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.