Struct PackageDescription

#[non_exhaustive]
pub struct PackageDescription {
    pub format: Option<PackageFormat>,
    pub namespace: Option<String>,
    pub name: Option<String>,
    pub origin_configuration: Option<PackageOriginConfiguration>,
}

Details about a package.

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.

format: Option<PackageFormat>

A format that specifies the type of the package.

namespace: Option<String>

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

name: Option<String>

The name of the package.

origin_configuration: Option<PackageOriginConfiguration>

The package origin configuration for the package.

Implementations

impl PackageDescription

pub fn format(&self) -> Option<&PackageFormat>

A format that specifies the type of the package.

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

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

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

The name of the package.

pub fn origin_configuration(&self) -> Option<&PackageOriginConfiguration>

The package origin configuration for the package.

impl PackageDescription

pub fn builder() -> PackageDescriptionBuilder

Creates a new builder-style object to manufacture PackageDescription.

Trait Implementations

impl Clone for PackageDescription

fn clone(&self) -> PackageDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageDescription

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

Formats the value using the given formatter.

impl PartialEq for PackageDescription

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