Struct cpython::GILProtected[−][src]

pub struct GILProtected<T> { /* fields omitted */ }

Mutex-like wrapper object for data that is protected by the Python GIL.

Example

use std::cell::Cell;
use cpython::{Python, GILProtected};

let data = GILProtected::new(Cell::new(0));

{
    let gil_guard = Python::acquire_gil();
    let cell = data.get(gil_guard.python());
    cell.set(cell.get() + 1);
}

Implementations

impl<T> GILProtected<T>[src]

pub const fn new(data: T) -> GILProtected<T>[src]

Creates a new instance of GILProtected.

pub fn get<'a>(&'a self, _py: Python<'a>) -> &'a T[src]

Returns a shared reference to the data stored in the GILProtected.

Requires a Python instance as proof that the GIL is acquired.

pub fn into_inner(self) -> T[src]

Consumes the GILProtected, returning the wrapped value.

Trait Implementations

impl<T: Send> Send for GILProtected<T>[src]

impl<T: Send> Sync for GILProtected<T>[src]

Because GILProtected ensures that the contained data is only accessed while the GIL is acquired, it can implement Sync even if the contained data does not.

Auto Trait Implementations

impl<T> RefUnwindSafe for GILProtected<T> where
    T: RefUnwindSafe, [src]

impl<T> Unpin for GILProtected<T> where
    T: Unpin, [src]

impl<T> UnwindSafe for GILProtected<T> where
    T: UnwindSafe, [src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.