#[non_exhaustive]pub struct PackageVersionDescriptionBuilder { /* private fields */ }
Expand description
A builder for PackageVersionDescription
.
Implementations§
Source§impl PackageVersionDescriptionBuilder
impl PackageVersionDescriptionBuilder
Sourcepub fn format(self, input: PackageFormat) -> Self
pub fn format(self, input: PackageFormat) -> Self
The format of the package version.
Sourcepub fn set_format(self, input: Option<PackageFormat>) -> Self
pub fn set_format(self, input: Option<PackageFormat>) -> Self
The format of the package version.
Sourcepub fn get_format(&self) -> &Option<PackageFormat>
pub fn get_format(&self) -> &Option<PackageFormat>
The format of the package version.
Sourcepub fn namespace(self, input: impl Into<String>) -> Self
pub fn namespace(self, input: impl Into<String>) -> Self
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, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
Sourcepub fn set_namespace(self, input: Option<String>) -> Self
pub fn set_namespace(self, input: Option<String>) -> Self
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, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
Sourcepub fn get_namespace(&self) -> &Option<String>
pub fn get_namespace(&self) -> &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, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
Sourcepub fn package_name(self, input: impl Into<String>) -> Self
pub fn package_name(self, input: impl Into<String>) -> Self
The name of the requested package.
Sourcepub fn set_package_name(self, input: Option<String>) -> Self
pub fn set_package_name(self, input: Option<String>) -> Self
The name of the requested package.
Sourcepub fn get_package_name(&self) -> &Option<String>
pub fn get_package_name(&self) -> &Option<String>
The name of the requested package.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
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 set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
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 get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &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
.
Sourcepub fn set_version(self, input: Option<String>) -> Self
pub fn set_version(self, input: Option<String>) -> Self
The version of the package.
Sourcepub fn get_version(&self) -> &Option<String>
pub fn get_version(&self) -> &Option<String>
The version of the package.
Sourcepub fn summary(self, input: impl Into<String>) -> Self
pub fn summary(self, input: impl Into<String>) -> Self
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 set_summary(self, input: Option<String>) -> Self
pub fn set_summary(self, input: Option<String>) -> Self
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 get_summary(&self) -> &Option<String>
pub fn get_summary(&self) -> &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.
Sourcepub fn home_page(self, input: impl Into<String>) -> Self
pub fn home_page(self, input: impl Into<String>) -> Self
The homepage associated with the package.
Sourcepub fn set_home_page(self, input: Option<String>) -> Self
pub fn set_home_page(self, input: Option<String>) -> Self
The homepage associated with the package.
Sourcepub fn get_home_page(&self) -> &Option<String>
pub fn get_home_page(&self) -> &Option<String>
The homepage associated with the package.
Sourcepub fn source_code_repository(self, input: impl Into<String>) -> Self
pub fn source_code_repository(self, input: impl Into<String>) -> Self
The repository for the source code in the package version, or the source code used to build it.
Sourcepub fn set_source_code_repository(self, input: Option<String>) -> Self
pub fn set_source_code_repository(self, input: Option<String>) -> Self
The repository for the source code in the package version, or the source code used to build it.
Sourcepub fn get_source_code_repository(&self) -> &Option<String>
pub fn get_source_code_repository(&self) -> &Option<String>
The repository for the source code in the package version, or the source code used to build it.
Sourcepub fn published_time(self, input: DateTime) -> Self
pub fn published_time(self, input: DateTime) -> Self
A timestamp that contains the date and time the package version was published.
Sourcepub fn set_published_time(self, input: Option<DateTime>) -> Self
pub fn set_published_time(self, input: Option<DateTime>) -> Self
A timestamp that contains the date and time the package version was published.
Sourcepub fn get_published_time(&self) -> &Option<DateTime>
pub fn get_published_time(&self) -> &Option<DateTime>
A timestamp that contains the date and time the package version was published.
Sourcepub fn licenses(self, input: LicenseInfo) -> Self
pub fn licenses(self, input: LicenseInfo) -> Self
Appends an item to licenses
.
To override the contents of this collection use set_licenses
.
Information about licenses associated with the package version.
Sourcepub fn set_licenses(self, input: Option<Vec<LicenseInfo>>) -> Self
pub fn set_licenses(self, input: Option<Vec<LicenseInfo>>) -> Self
Information about licenses associated with the package version.
Sourcepub fn get_licenses(&self) -> &Option<Vec<LicenseInfo>>
pub fn get_licenses(&self) -> &Option<Vec<LicenseInfo>>
Information about licenses associated with the package version.
Sourcepub fn set_revision(self, input: Option<String>) -> Self
pub fn set_revision(self, input: Option<String>) -> Self
The revision of the package version.
Sourcepub fn get_revision(&self) -> &Option<String>
pub fn get_revision(&self) -> &Option<String>
The revision of the package version.
Sourcepub fn status(self, input: PackageVersionStatus) -> Self
pub fn status(self, input: PackageVersionStatus) -> Self
A string that contains the status of the package version.
Sourcepub fn set_status(self, input: Option<PackageVersionStatus>) -> Self
pub fn set_status(self, input: Option<PackageVersionStatus>) -> Self
A string that contains the status of the package version.
Sourcepub fn get_status(&self) -> &Option<PackageVersionStatus>
pub fn get_status(&self) -> &Option<PackageVersionStatus>
A string that contains the status of the package version.
Sourcepub fn origin(self, input: PackageVersionOrigin) -> Self
pub fn origin(self, input: PackageVersionOrigin) -> Self
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
Sourcepub fn set_origin(self, input: Option<PackageVersionOrigin>) -> Self
pub fn set_origin(self, input: Option<PackageVersionOrigin>) -> Self
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
Sourcepub fn get_origin(&self) -> &Option<PackageVersionOrigin>
pub fn get_origin(&self) -> &Option<PackageVersionOrigin>
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
Sourcepub fn build(self) -> PackageVersionDescription
pub fn build(self) -> PackageVersionDescription
Consumes the builder and constructs a PackageVersionDescription
.
Trait Implementations§
Source§impl Clone for PackageVersionDescriptionBuilder
impl Clone for PackageVersionDescriptionBuilder
Source§fn clone(&self) -> PackageVersionDescriptionBuilder
fn clone(&self) -> PackageVersionDescriptionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for PackageVersionDescriptionBuilder
impl Default for PackageVersionDescriptionBuilder
Source§fn default() -> PackageVersionDescriptionBuilder
fn default() -> PackageVersionDescriptionBuilder
Source§impl PartialEq for PackageVersionDescriptionBuilder
impl PartialEq for PackageVersionDescriptionBuilder
Source§fn eq(&self, other: &PackageVersionDescriptionBuilder) -> bool
fn eq(&self, other: &PackageVersionDescriptionBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for PackageVersionDescriptionBuilder
Auto Trait Implementations§
impl Freeze for PackageVersionDescriptionBuilder
impl RefUnwindSafe for PackageVersionDescriptionBuilder
impl Send for PackageVersionDescriptionBuilder
impl Sync for PackageVersionDescriptionBuilder
impl Unpin for PackageVersionDescriptionBuilder
impl UnwindSafe for PackageVersionDescriptionBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);