Metadata23

Struct Metadata23 

Source
pub struct Metadata23 {
Show 27 fields pub metadata_version: String, pub name: String, pub version: String, pub platforms: Vec<String>, pub supported_platforms: 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_expression: Option<String>, pub license_files: Vec<String>, pub classifiers: Vec<String>, pub requires_dist: Vec<String>, pub provides_dist: Vec<String>, pub obsoletes_dist: Vec<String>, pub requires_python: Option<String>, pub requires_external: Vec<String>, pub project_urls: Vec<String>, pub provides_extra: Vec<String>, pub dynamic: Vec<String>,
}
Expand description

Fields§

§metadata_version: String

Version of the file format; legal values are 1.0, 1.1, 1.2, 2.1, 2.2, 2.3 and 2.4.

§name: String

The name of the distribution.

§version: String

A string containing the distribution’s version number.

§platforms: Vec<String>

A Platform specification describing an operating system supported by the distribution which is not listed in the “Operating System” Trove classifiers.

§supported_platforms: Vec<String>

Binary distributions containing a PKG-INFO file will use the Supported-Platform field in their metadata to specify the OS and CPU for which the binary distribution was compiled.

§summary: Option<String>

A one-line summary of what the distribution does.

§description: Option<String>

A longer description of the distribution that can run to several paragraphs.

§description_content_type: Option<String>

A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description.

Known values: text/plain, text/markdown and text/x-rst.

§keywords: Option<String>

A list of additional keywords, separated by commas, to be used to assist searching for the distribution in a larger catalog.

§home_page: Option<String>

A string containing the URL for the distribution’s home page.

Deprecated by PEP 753.

§download_url: Option<String>

A string containing the URL from which this version of the distribution can be downloaded.

Deprecated by PEP 753.

§author: Option<String>

A string containing the author’s name at a minimum; additional contact information may be provided.

§author_email: Option<String>

A string containing the author’s e-mail address. It can contain a name and e-mail address in the legal forms for an RFC-822 From: header.

§maintainer: Option<String>

A string containing the maintainer’s name at a minimum; additional contact information may be provided.

Note that this field is intended for use when a project is being maintained by someone other than the original author: it should be omitted if it is identical to author.

§maintainer_email: Option<String>

A string containing the maintainer’s e-mail address. It can contain a name and e-mail address in the legal forms for a RFC-822 From: header.

Note that this field is intended for use when a project is being maintained by someone other than the original author: it should be omitted if it is identical to author_email.

§license: Option<String>

Text indicating the license covering the distribution where the license is not a selection from the License Trove classifiers or an SPDX license expression.

§license_expression: Option<String>

An SPDX expression indicating the license covering the distribution.

Introduced by PEP 639, requires metadata version 2.4.

§license_files: Vec<String>

Paths to files containing the text of the licenses covering the distribution.

Introduced by PEP 639, requires metadata version 2.4.

§classifiers: Vec<String>

Each entry is a string giving a single classification value for the distribution.

§requires_dist: Vec<String>

Each entry contains a string naming some other distutils project required by this distribution.

§provides_dist: Vec<String>

Each entry contains a string naming a Distutils project which is contained within this distribution.

§obsoletes_dist: Vec<String>

Each entry contains a string describing a distutils project’s distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.

§requires_python: Option<String>

This field specifies the Python version(s) that the distribution is guaranteed to be compatible with.

§requires_external: Vec<String>

Each entry contains a string describing some dependency in the system that the distribution is to be used.

§project_urls: Vec<String>

A string containing a browsable URL for the project and a label for it, separated by a comma.

§provides_extra: Vec<String>

A string containing the name of an optional feature. Must be a valid Python identifier. May be used to make a dependency conditional on whether the optional feature has been requested.

§dynamic: Vec<String>

A string containing the name of another core metadata field.

Implementations§

Source§

impl Metadata23

Source

pub fn parse(content: &[u8]) -> Result<Self, MetadataError>

Parse distribution metadata from metadata MetadataError

Source

pub fn core_metadata_format(&self) -> String

Convert to the pseudo-email format used by Python’s METADATA.

The standard file format for metadata (including in wheels and installed projects) is based on the format of email headers. However, email formats have been revised several times, and exactly which email RFC applies to packaging metadata is not specified. In the absence of a precise definition, the practical standard is set by what the standard library email.parser module can parse using the compat32 policy.

§Example
Metadata-Version: 2.3
Name: hello-world
Version: 0.1.0
License: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
         INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A [...]

Trait Implementations§

Source§

impl Clone for Metadata23

Source§

fn clone(&self) -> Metadata23

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Metadata23

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Metadata23

Source§

fn default() -> Metadata23

Returns the “default value” for a type. Read more
Source§

impl FromStr for Metadata23

Source§

type Err = MetadataError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for Metadata23

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Metadata23

Source§

impl StructuralPartialEq for Metadata23

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,