Enum pyo3_stub_gen::stub_type::ModuleRef

pub enum ModuleRef {
    Named(String),
    Default,
}

Variants

Named(String)

Default

Default module that PyO3 creates.

• For pure Rust project, the default module name is the crate name specified in Cargo.toml or project.name specified in pyproject.toml
• For mixed Rust/Python project, the default module name is tool.maturin.module-name specified in pyproject.toml

Because the default module name cannot be known at compile time, it will be resolved at the time of the stub file generation. This is a placeholder for the default module name.

Implementations

impl ModuleRef

pub fn get(&self) -> Option<&str>

Trait Implementations

impl Clone for ModuleRef

fn clone(&self) -> ModuleRef

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModuleRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ModuleRef

fn default() -> ModuleRef

Returns the “default value” for a type.

impl From<&str> for ModuleRef

fn from(s: &str) -> Self

Converts to this type from the input type.

impl Hash for ModuleRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ModuleRef

fn cmp(&self, other: &ModuleRef) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ModuleRef

fn eq(&self, other: &ModuleRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ModuleRef

fn partial_cmp(&self, other: &ModuleRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ModuleRef

impl StructuralPartialEq for ModuleRef