#[non_exhaustive]pub struct PackageVersionDescription {Show 13 fields
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>,
}
Expand description
Details about a package version.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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, and Ruby 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§
source§impl PackageVersionDescription
impl PackageVersionDescription
sourcepub fn format(&self) -> Option<&PackageFormat>
pub fn format(&self) -> Option<&PackageFormat>
The format of the package version.
sourcepub fn namespace(&self) -> Option<&str>
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, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
sourcepub fn package_name(&self) -> Option<&str>
pub fn package_name(&self) -> Option<&str>
The name of the requested package.
sourcepub fn display_name(&self) -> Option<&str>
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
.
sourcepub fn summary(&self) -> Option<&str>
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.
sourcepub fn source_code_repository(&self) -> Option<&str>
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.
sourcepub fn published_time(&self) -> Option<&DateTime>
pub fn published_time(&self) -> Option<&DateTime>
A timestamp that contains the date and time the package version was published.
sourcepub fn licenses(&self) -> &[LicenseInfo]
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()
.
sourcepub fn status(&self) -> Option<&PackageVersionStatus>
pub fn status(&self) -> Option<&PackageVersionStatus>
A string that contains the status of the package version.
sourcepub fn origin(&self) -> Option<&PackageVersionOrigin>
pub fn origin(&self) -> Option<&PackageVersionOrigin>
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
source§impl PackageVersionDescription
impl PackageVersionDescription
sourcepub fn builder() -> PackageVersionDescriptionBuilder
pub fn builder() -> PackageVersionDescriptionBuilder
Creates a new builder-style object to manufacture PackageVersionDescription
.
Trait Implementations§
source§impl Clone for PackageVersionDescription
impl Clone for PackageVersionDescription
source§fn clone(&self) -> PackageVersionDescription
fn clone(&self) -> PackageVersionDescription
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PackageVersionDescription
impl Debug for PackageVersionDescription
source§impl PartialEq for PackageVersionDescription
impl PartialEq for PackageVersionDescription
source§fn eq(&self, other: &PackageVersionDescription) -> bool
fn eq(&self, other: &PackageVersionDescription) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for PackageVersionDescription
Auto Trait Implementations§
impl Freeze for PackageVersionDescription
impl RefUnwindSafe for PackageVersionDescription
impl Send for PackageVersionDescription
impl Sync for PackageVersionDescription
impl Unpin for PackageVersionDescription
impl UnwindSafe for PackageVersionDescription
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more