Struct PackageDependency

#[non_exhaustive]
pub struct PackageDependency {
    pub namespace: Option<String>,
    pub package: Option<String>,
    pub dependency_type: Option<String>,
    pub version_requirement: Option<String>,
}

Details about a package dependency.

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.

namespace: Option<String>

The namespace of the package that this package depends on. 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: Option<String>

The name of the package that this package depends on.

dependency_type: Option<String>

The type of a package dependency. The possible values depend on the package type.

• npm: regular, dev, peer, optional

• maven: optional, parent, compile, runtime, test, system, provided.

  Note that parent is not a regular Maven dependency type; instead this is extracted from the element if one is defined in the package version's POM file.

• nuget: The dependencyType field is never set for NuGet packages.

• pypi: Requires-Dist

version_requirement: Option<String>

The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

Implementations

impl PackageDependency

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

The namespace of the package that this package depends on. 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(&self) -> Option<&str>

The name of the package that this package depends on.

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

The type of a package dependency. The possible values depend on the package type.

• npm: regular, dev, peer, optional

• maven: optional, parent, compile, runtime, test, system, provided.

  Note that parent is not a regular Maven dependency type; instead this is extracted from the element if one is defined in the package version's POM file.

• nuget: The dependencyType field is never set for NuGet packages.

• pypi: Requires-Dist

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

The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

impl PackageDependency

pub fn builder() -> PackageDependencyBuilder

Creates a new builder-style object to manufacture PackageDependency.

Trait Implementations

impl Clone for PackageDependency

fn clone(&self) -> PackageDependency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageDependency

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

Formats the value using the given formatter.

impl PartialEq for PackageDependency

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