Struct GetPackageVersionReadmeOutput

#[non_exhaustive]
pub struct GetPackageVersionReadmeOutput {
    pub format: Option<PackageFormat>,
    pub namespace: Option<String>,
    pub package: Option<String>,
    pub version: Option<String>,
    pub version_revision: Option<String>,
    pub readme: Option<String>,
    /* private fields */
}

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 with the requested readme file.

namespace: Option<String>

The namespace of the package version with the requested readme file. 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 contains the returned readme file.

version: Option<String>

The version of the package with the requested readme file.

version_revision: Option<String>

The current revision associated with the package version.

readme: Option<String>

The text of the returned readme file.

Implementations

impl GetPackageVersionReadmeOutput

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

The format of the package with the requested readme file.

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

The namespace of the package version with the requested readme file. 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 contains the returned readme file.

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

The version of the package with the requested readme file.

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

The current revision associated with the package version.

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

The text of the returned readme file.

impl GetPackageVersionReadmeOutput

pub fn builder() -> GetPackageVersionReadmeOutputBuilder

Creates a new builder-style object to manufacture GetPackageVersionReadmeOutput.

Trait Implementations

impl Clone for GetPackageVersionReadmeOutput

fn clone(&self) -> GetPackageVersionReadmeOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetPackageVersionReadmeOutput

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

Formats the value using the given formatter.

impl PartialEq for GetPackageVersionReadmeOutput

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

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetPackageVersionReadmeOutput