Struct python_packaging::resource::PythonExtensionModule

pub struct PythonExtensionModule {
    pub name: String,
    pub init_fn: Option<String>,
    pub extension_file_suffix: String,
    pub shared_library: Option<FileData>,
    pub object_file_data: Vec<FileData>,
    pub is_package: bool,
    pub link_libraries: Vec<LibraryDependency>,
    pub is_stdlib: bool,
    pub builtin_default: bool,
    pub required: bool,
    pub variant: Option<String>,
    pub license: Option<LicensedComponent>,
}

Represents a Python extension module.

Fields

name: String

The module name this extension module is providing.

init_fn: Option<String>

Name of the C function initializing this extension module.

extension_file_suffix: String

Filename suffix to use when writing extension module data.

shared_library: Option<FileData>

File data for linked extension module.

object_file_data: Vec<FileData>

File data for object files linked together to produce this extension module.

is_package: bool

Whether this extension module is a package.

link_libraries: Vec<LibraryDependency>

Libraries that this extension depends on.

is_stdlib: bool

Whether this extension module is part of the Python standard library.

This is true if the extension is distributed with Python itself.

builtin_default: bool

Whether the extension module is built-in by default.

Some extension modules in Python distributions are always compiled into libpython. This field will be true for those extension modules.

required: bool

Whether the extension must be loaded to initialize Python.

variant: Option<String>

Name of the variant of this extension module.

This may be set if there are multiple versions of an extension module available to choose from.

license: Option<LicensedComponent>

Licenses that apply to this extension.

Implementations

impl PythonExtensionModule

pub fn description(&self) -> String

pub fn to_memory(&self) -> Result<Self>

pub fn file_name(&self) -> String

The file name (without parent components) this extension module should be realized with.

pub fn resolve_path(&self, prefix: &str) -> PathBuf

Resolve the filesystem path for this extension module.

pub fn package_parts(&self) -> Vec<String>

Returns the part strings constituting the package name.

pub fn requires_libraries(&self) -> bool

Whether the extension module requires additional libraries.

pub fn is_minimally_required(&self) -> bool

Whether the extension module is minimally required for a Python interpreter.

This will be true only for extension modules in the standard library that are builtins part of libpython or are required as part of Python interpreter initialization.

pub fn in_libpython(&self) -> bool

Whether this extension module is already in libpython.

This is true if this is a stdlib extension module and is a core module or no shared library extension module is available.

pub fn top_level_package(&self) -> &str

Obtain the top-level package name this module belongs to.

Trait Implementations

impl Clone for PythonExtensionModule

fn clone(&self) -> PythonExtensionModule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PythonExtensionModule

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

Formats the value using the given formatter.

impl<'a> From<&'a PythonExtensionModule> for PythonResource<'a>

fn from(r: &'a PythonExtensionModule) -> Self

Converts to this type from the input type.

impl<'a> From<PythonExtensionModule> for PythonResource<'a>

fn from(r: PythonExtensionModule) -> Self

Converts to this type from the input type.

impl FromIterator<PythonExtensionModule> for PythonExtensionModuleVariants

fn from_iter<I: IntoIterator<Item = PythonExtensionModule>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq<PythonExtensionModule> for PythonExtensionModule

fn eq(&self, other: &PythonExtensionModule) -> 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 StructuralPartialEq for PythonExtensionModule