Skip to main content

ModuleDef

Struct ModuleDef 

Source
pub struct ModuleDef {
    ffi_def: UnsafeCell<PyModuleDef>,
    slots: &'static PyModuleSlots,
    interpreter: AtomicI64,
    module: PyOnceLock<Py<PyModule>>,
}
Expand description

Sync wrapper of ffi::PyModuleDef.

Fields§

§ffi_def: UnsafeCell<PyModuleDef>§slots: &'static PyModuleSlots§interpreter: AtomicI64
Available on neither PyPy nor GraalPy and Py_3_9 and not (Windows and Py_LIMITED_API and non-Py_3_10) only.

Interpreter ID where module was initialized (not applicable on PyPy).

§module: PyOnceLock<Py<PyModule>>

Initialized module object, cached to avoid reinitialization.

Implementations§

Source§

impl ModuleDef

Source

pub const fn new( name: &'static CStr, doc: &'static CStr, slots: &'static PyModuleSlots, ) -> Self

Make new module definition with given module name.

Source

pub fn init_multi_phase(&'static self) -> *mut PyObject

Source

pub fn make_module(&'static self, py: Python<'_>) -> PyResult<Py<PyModule>>

Builds a module object directly. Used for #[pymodule] submodules.

Source

pub fn get_slots(&'static self) -> *mut PyModuleDef_Slot

Trait Implementations§

Source§

impl PyAddToModule for ModuleDef

For adding a module to a module.

Source§

fn add_to_module(&'static self, module: &Bound<'_, PyModule>) -> PyResult<()>

Source§

impl Sealed for ModuleDef

Source§

impl Sync for ModuleDef

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> SizedTypeProperties for T

Source§

#[doc(hidden)]
const SIZE: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGNMENT: Alignment = _

🔬This is a nightly-only experimental API. (ptr_alignment_type)
Source§

#[doc(hidden)]
const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)]
const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const MAX_SLICE_LEN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
The largest safe length for a [Self]. Read more
Source§

impl<T> SomeWrap<T> for T

Source§

fn wrap(self) -> Option<T>

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here