Struct PackageDependencyBuilder

#[non_exhaustive]
pub struct PackageDependencyBuilder { /* private fields */ }

A builder for PackageDependency.

Implementations

impl PackageDependencyBuilder

pub fn namespace(self, input: impl Into<String>) -> Self

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 set_namespace(self, input: Option<String>) -> Self

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 get_namespace(&self) -> &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.

pub fn package(self, input: impl Into<String>) -> Self

The name of the package that this package depends on.

pub fn set_package(self, input: Option<String>) -> Self

The name of the package that this package depends on.

pub fn get_package(&self) -> &Option<String>

The name of the package that this package depends on.

pub fn dependency_type(self, input: impl Into<String>) -> Self

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 set_dependency_type(self, input: Option<String>) -> Self

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 get_dependency_type(&self) -> &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

pub fn version_requirement(self, input: impl Into<String>) -> Self

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.

pub fn set_version_requirement(self, input: Option<String>) -> Self

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.

pub fn get_version_requirement(&self) -> &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.

pub fn build(self) -> PackageDependency

Consumes the builder and constructs a PackageDependency.

Trait Implementations

impl Clone for PackageDependencyBuilder

fn clone(&self) -> PackageDependencyBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageDependencyBuilder

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

Formats the value using the given formatter.

impl Default for PackageDependencyBuilder

fn default() -> PackageDependencyBuilder

Returns the “default value” for a type.

impl PartialEq for PackageDependencyBuilder

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