Struct PackageVersionDescription

#[non_exhaustive]
pub struct PackageVersionDescription {

    pub format: Option<PackageFormat>,
    pub namespace: Option<String>,
    pub package_name: Option<String>,
    pub display_name: Option<String>,
    pub version: Option<String>,
    pub summary: Option<String>,
    pub home_page: Option<String>,
    pub source_code_repository: Option<String>,
    pub published_time: Option<DateTime>,
    pub licenses: Option<Vec<LicenseInfo>>,
    pub revision: Option<String>,
    pub status: Option<PackageVersionStatus>,
    pub origin: Option<PackageVersionOrigin>,
}

Details about a package version.

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>

The format of the package version.

namespace: Option<String>

The namespace of the package version. 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.

package_name: Option<String>

The name of the requested package.

display_name: Option<String>

The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

version: Option<String>

The version of the package.

summary: Option<String>

A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

home_page: Option<String>

The homepage associated with the package.

source_code_repository: Option<String>

The repository for the source code in the package version, or the source code used to build it.

published_time: Option<DateTime>

A timestamp that contains the date and time the package version was published.

licenses: Option<Vec<LicenseInfo>>

Information about licenses associated with the package version.

revision: Option<String>

The revision of the package version.

status: Option<PackageVersionStatus>

A string that contains the status of the package version.

origin: Option<PackageVersionOrigin>

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

Implementations

impl PackageVersionDescription

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

The format of the package version.

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

The namespace of the package version. 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 package_name(&self) -> Option<&str>

The name of the requested package.

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

The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

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

The version of the package.

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

A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

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

The homepage associated with the package.

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

The repository for the source code in the package version, or the source code used to build it.

pub fn published_time(&self) -> Option<&DateTime>

A timestamp that contains the date and time the package version was published.

pub fn licenses(&self) -> &[LicenseInfo]

Information about licenses associated with the package version.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .licenses.is_none().

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

The revision of the package version.

pub fn status(&self) -> Option<&PackageVersionStatus>

A string that contains the status of the package version.

pub fn origin(&self) -> Option<&PackageVersionOrigin>

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

impl PackageVersionDescription

pub fn builder() -> PackageVersionDescriptionBuilder

Creates a new builder-style object to manufacture PackageVersionDescription.

Trait Implementations

impl Clone for PackageVersionDescription

fn clone(&self) -> PackageVersionDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageVersionDescription

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

Formats the value using the given formatter.

impl PartialEq for PackageVersionDescription

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