Struct Metadata 

#[non_exhaustive]
pub struct Metadata {
    pub package_name: PackageName,
    pub version: String,
    pub description: Option<String>,
}

Information about the Package being generated.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

package_name: PackageName

The package’s name.

version: String

A semver-compliant version number.

description: Option<String>

Extended information about the package.

Implementations

impl Metadata

pub fn new(package_name: PackageName, version: impl Into<String>) -> Self

Create a new Metadata object with all required fields.

pub fn with_description(self, description: impl Into<String>) -> Self

Set the Metadata::description field.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl PartialEq for Metadata

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Metadata

impl StructuralPartialEq for Metadata