#[non_exhaustive]pub struct GetPackageVersionReadmeOutputBuilder { /* private fields */ }
Expand description
A builder for GetPackageVersionReadmeOutput
.
Implementations§
Source§impl GetPackageVersionReadmeOutputBuilder
impl GetPackageVersionReadmeOutputBuilder
Sourcepub fn format(self, input: PackageFormat) -> Self
pub fn format(self, input: PackageFormat) -> Self
The format of the package with the requested readme file.
Sourcepub fn set_format(self, input: Option<PackageFormat>) -> Self
pub fn set_format(self, input: Option<PackageFormat>) -> Self
The format of the package with the requested readme file.
Sourcepub fn get_format(&self) -> &Option<PackageFormat>
pub fn get_format(&self) -> &Option<PackageFormat>
The format of the package with the requested readme file.
Sourcepub fn namespace(self, input: impl Into<String>) -> Self
pub fn namespace(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_namespace(self, input: Option<String>) -> Self
pub fn set_namespace(self, input: Option<String>) -> Self
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.
Sourcepub fn get_namespace(&self) -> &Option<String>
pub fn get_namespace(&self) -> &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.
Sourcepub fn package(self, input: impl Into<String>) -> Self
pub fn package(self, input: impl Into<String>) -> Self
The name of the package that contains the returned readme file.
Sourcepub fn set_package(self, input: Option<String>) -> Self
pub fn set_package(self, input: Option<String>) -> Self
The name of the package that contains the returned readme file.
Sourcepub fn get_package(&self) -> &Option<String>
pub fn get_package(&self) -> &Option<String>
The name of the package that contains the returned readme file.
Sourcepub fn version(self, input: impl Into<String>) -> Self
pub fn version(self, input: impl Into<String>) -> Self
The version of the package with the requested readme file.
Sourcepub fn set_version(self, input: Option<String>) -> Self
pub fn set_version(self, input: Option<String>) -> Self
The version of the package with the requested readme file.
Sourcepub fn get_version(&self) -> &Option<String>
pub fn get_version(&self) -> &Option<String>
The version of the package with the requested readme file.
Sourcepub fn version_revision(self, input: impl Into<String>) -> Self
pub fn version_revision(self, input: impl Into<String>) -> Self
The current revision associated with the package version.
Sourcepub fn set_version_revision(self, input: Option<String>) -> Self
pub fn set_version_revision(self, input: Option<String>) -> Self
The current revision associated with the package version.
Sourcepub fn get_version_revision(&self) -> &Option<String>
pub fn get_version_revision(&self) -> &Option<String>
The current revision associated with the package version.
Sourcepub fn set_readme(self, input: Option<String>) -> Self
pub fn set_readme(self, input: Option<String>) -> Self
The text of the returned readme file.
Sourcepub fn get_readme(&self) -> &Option<String>
pub fn get_readme(&self) -> &Option<String>
The text of the returned readme file.
Sourcepub fn build(self) -> GetPackageVersionReadmeOutput
pub fn build(self) -> GetPackageVersionReadmeOutput
Consumes the builder and constructs a GetPackageVersionReadmeOutput
.
Trait Implementations§
Source§impl Clone for GetPackageVersionReadmeOutputBuilder
impl Clone for GetPackageVersionReadmeOutputBuilder
Source§fn clone(&self) -> GetPackageVersionReadmeOutputBuilder
fn clone(&self) -> GetPackageVersionReadmeOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for GetPackageVersionReadmeOutputBuilder
impl Default for GetPackageVersionReadmeOutputBuilder
Source§fn default() -> GetPackageVersionReadmeOutputBuilder
fn default() -> GetPackageVersionReadmeOutputBuilder
Source§impl PartialEq for GetPackageVersionReadmeOutputBuilder
impl PartialEq for GetPackageVersionReadmeOutputBuilder
Source§fn eq(&self, other: &GetPackageVersionReadmeOutputBuilder) -> bool
fn eq(&self, other: &GetPackageVersionReadmeOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for GetPackageVersionReadmeOutputBuilder
Auto Trait Implementations§
impl Freeze for GetPackageVersionReadmeOutputBuilder
impl RefUnwindSafe for GetPackageVersionReadmeOutputBuilder
impl Send for GetPackageVersionReadmeOutputBuilder
impl Sync for GetPackageVersionReadmeOutputBuilder
impl Unpin for GetPackageVersionReadmeOutputBuilder
impl UnwindSafe for GetPackageVersionReadmeOutputBuilder
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);