#[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
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, 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

source

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

The format of the package version.

source

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.

source

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

The name of the requested package.

source

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.

source

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

The version of the package.

source

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.

source

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

The homepage associated with the package.

source

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.

source

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

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

source

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().

source

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

The revision of the package version.

source

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

A string that contains the status of the package version.

source

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

source

pub fn builder() -> PackageVersionDescriptionBuilder

Creates a new builder-style object to manufacture PackageVersionDescription.

Trait Implementations§

source§

impl Clone for PackageVersionDescription

source§

fn clone(&self) -> PackageVersionDescription

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PackageVersionDescription

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for PackageVersionDescription

source§

fn eq(&self, other: &PackageVersionDescription) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for PackageVersionDescription

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more