Struct maturin::Metadata23

pub struct Metadata23 {

    pub metadata_version: String,
    pub name: String,
    pub version: Version,
    pub platform: Vec<String>,
    pub supported_platform: Vec<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub description_content_type: Option<String>,
    pub keywords: Option<String>,
    pub home_page: Option<String>,
    pub download_url: Option<String>,
    pub author: Option<String>,
    pub author_email: Option<String>,
    pub maintainer: Option<String>,
    pub maintainer_email: Option<String>,
    pub license: Option<String>,
    pub license_files: Vec<PathBuf>,
    pub classifiers: Vec<String>,
    pub requires_dist: Vec<Requirement>,
    pub provides_dist: Vec<String>,
    pub obsoletes_dist: Vec<String>,
    pub requires_python: Option<VersionSpecifiers>,
    pub requires_external: Vec<String>,
    pub project_url: IndexMap<String, String>,
    pub provides_extra: Vec<String>,
    pub scripts: IndexMap<String, String>,
    pub gui_scripts: IndexMap<String, String>,
    pub entry_points: IndexMap<String, IndexMap<String, String>>,
}

Python Package Metadata 2.3 as specified in https://packaging.python.org/specifications/core-metadata/ Maturin writes static metadata and does not support dynamic fields atm.

Fields

metadata_version: String

name: String

version: Version

platform: Vec<String>

supported_platform: Vec<String>

summary: Option<String>

description: Option<String>

description_content_type: Option<String>

keywords: Option<String>

home_page: Option<String>

download_url: Option<String>

author: Option<String>

author_email: Option<String>

maintainer: Option<String>

maintainer_email: Option<String>

license: Option<String>

license_files: Vec<PathBuf>

classifiers: Vec<String>

requires_dist: Vec<Requirement>

provides_dist: Vec<String>

obsoletes_dist: Vec<String>

requires_python: Option<VersionSpecifiers>

requires_external: Vec<String>

project_url: IndexMap<String, String>

provides_extra: Vec<String>

scripts: IndexMap<String, String>

gui_scripts: IndexMap<String, String>

entry_points: IndexMap<String, IndexMap<String, String>>

Implementations

impl Metadata23

pub fn new(name: String, version: Version) -> Self

Initializes with name, version and otherwise the defaults

impl Metadata23

pub fn merge_pyproject_toml( &mut self, pyproject_dir: impl AsRef<Path>, pyproject_toml: &PyProjectToml ) -> Result<()>

Merge metadata with pyproject.toml, where pyproject.toml takes precedence

pyproject_dir must be the directory containing pyproject.toml

pub fn from_cargo_toml( manifest_path: impl AsRef<Path>, cargo_metadata: &Metadata ) -> Result<Metadata23>

Uses a Cargo.toml to create the metadata for python packages

manifest_path must be the directory, not the file

pub fn to_vec(&self) -> Vec<(String, String)>

Formats the metadata into a list where keys with multiple values become multiple single-valued key-value pairs. This format is needed for the pypi uploader and for the METADATA file inside wheels

pub fn to_file_contents(&self) -> Result<String>

Writes the format for the metadata file inside wheels

pub fn get_distribution_escaped(&self) -> String

Returns the distribution name according to PEP 427, Section “Escaping and Unicode”

pub fn get_version_escaped(&self) -> String

Returns the version encoded according to PEP 427, Section “Escaping and Unicode”

pub fn get_dist_info_dir(&self) -> PathBuf

Returns the name of the .dist-info directory as defined in the wheel specification

Trait Implementations

impl Clone for Metadata23

fn clone(&self) -> Metadata23

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata23

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata23

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Metadata23

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Metadata23

impl StructuralPartialEq for Metadata23