Struct cpython::GILGuard

pub struct GILGuard { /* fields omitted */ }

RAII type that represents the Global Interpreter Lock acquisition.

Example

use cpython::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.

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

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

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

pub fn check() -> bool

Checks if the current thread holds the GIL.

This method is only available with Python 3.

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.