Struct pyo3::gil::GILPool

source · [−]

pub struct GILPool {
    start: Option<usize>,
    _not_send: NotSend,
}

Expand description

A RAII pool which PyO3 uses to store owned Python references.

See the Memory Management chapter of the guide for more information about how PyO3 uses GILPool to manage memory.

Fields

start: Option<usize>

Initial length of owned objects and anys. Option is used since TSL can be broken when new is called from atexit.

_not_send: NotSend

Implementations

source

impl GILPool

source

pub unsafe fn new() -> GILPool

Creates a new GILPool. This function should only ever be called with the GIL held.

It is recommended not to use this API directly, but instead to use Python::new_pool, as that guarantees the GIL is held.

Safety

As well as requiring the GIL, see the safety notes on Python::new_pool.

source

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

Gets the Python token associated with this GILPool.

Trait Implementations

source

impl Drop for GILPool

source

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations

impl RefUnwindSafe for GILPool

impl !Send for GILPool

impl !Sync for GILPool

impl Unpin for GILPool

impl UnwindSafe for GILPool

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct pyo3::gil::GILPool

Fields

Implementations

impl GILPool

pub unsafe fn new() -> GILPool

Safety

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

Trait Implementations

impl Drop for GILPool

fn drop(&mut self)

Auto Trait Implementations

impl RefUnwindSafe for GILPool

impl !Send for GILPool

impl !Sync for GILPool

impl Unpin for GILPool

impl UnwindSafe for GILPool

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Ungil for T where
T: Send,

Struct pyo3::gil::GILPool

Fields

Implementations

impl GILPool

pub unsafe fn new() -> GILPool

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

Trait Implementations

impl Drop for GILPool

fn drop(&mut self)

Auto Trait Implementations

impl RefUnwindSafe for GILPool

impl !Send for GILPool

impl !Sync for GILPool

impl Unpin for GILPool

impl UnwindSafe for GILPool

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Ungil for T where T: Send,

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> Ungil for T where
T: Send,