pub struct GetPackageVersionReadmeFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetPackageVersionReadme
.
Gets the readme file or descriptive text for a package version.
The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
Implementations§
Source§impl GetPackageVersionReadmeFluentBuilder
impl GetPackageVersionReadmeFluentBuilder
Sourcepub fn as_input(&self) -> &GetPackageVersionReadmeInputBuilder
pub fn as_input(&self) -> &GetPackageVersionReadmeInputBuilder
Access the GetPackageVersionReadme as a reference.
Sourcepub async fn send(
self,
) -> Result<GetPackageVersionReadmeOutput, SdkError<GetPackageVersionReadmeError, HttpResponse>>
pub async fn send( self, ) -> Result<GetPackageVersionReadmeOutput, SdkError<GetPackageVersionReadmeError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<GetPackageVersionReadmeOutput, GetPackageVersionReadmeError, Self>
pub fn customize( self, ) -> CustomizableOperation<GetPackageVersionReadmeOutput, GetPackageVersionReadmeError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn domain(self, input: impl Into<String>) -> Self
pub fn domain(self, input: impl Into<String>) -> Self
The name of the domain that contains the repository that contains the package version with the requested readme file.
Sourcepub fn set_domain(self, input: Option<String>) -> Self
pub fn set_domain(self, input: Option<String>) -> Self
The name of the domain that contains the repository that contains the package version with the requested readme file.
Sourcepub fn get_domain(&self) -> &Option<String>
pub fn get_domain(&self) -> &Option<String>
The name of the domain that contains the repository that contains the package version with the requested readme file.
Sourcepub fn domain_owner(self, input: impl Into<String>) -> Self
pub fn domain_owner(self, input: impl Into<String>) -> Self
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Sourcepub fn set_domain_owner(self, input: Option<String>) -> Self
pub fn set_domain_owner(self, input: Option<String>) -> Self
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Sourcepub fn get_domain_owner(&self) -> &Option<String>
pub fn get_domain_owner(&self) -> &Option<String>
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Sourcepub fn repository(self, input: impl Into<String>) -> Self
pub fn repository(self, input: impl Into<String>) -> Self
The repository that contains the package with the requested readme file.
Sourcepub fn set_repository(self, input: Option<String>) -> Self
pub fn set_repository(self, input: Option<String>) -> Self
The repository that contains the package with the requested readme file.
Sourcepub fn get_repository(&self) -> &Option<String>
pub fn get_repository(&self) -> &Option<String>
The repository that contains the package with the requested readme file.
Sourcepub fn format(self, input: PackageFormat) -> Self
pub fn format(self, input: PackageFormat) -> Self
A format that specifies the type of the package version with the requested readme file.
Sourcepub fn set_format(self, input: Option<PackageFormat>) -> Self
pub fn set_format(self, input: Option<PackageFormat>) -> Self
A format that specifies the type of the package version with the requested readme file.
Sourcepub fn get_format(&self) -> &Option<PackageFormat>
pub fn get_format(&self) -> &Option<PackageFormat>
A format that specifies the type of the package version 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 is required when requesting the readme from package versions of the following formats:
-
Maven
-
Swift
-
generic
-
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 is required when requesting the readme from package versions of the following formats:
-
Maven
-
Swift
-
generic
-
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 is required when requesting the readme from package versions of the following formats:
-
Maven
-
Swift
-
generic
-
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 version that contains the requested 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 version that contains the requested readme file.
Sourcepub fn get_package(&self) -> &Option<String>
pub fn get_package(&self) -> &Option<String>
The name of the package version that contains the requested readme file.
Sourcepub fn package_version(self, input: impl Into<String>) -> Self
pub fn package_version(self, input: impl Into<String>) -> Self
A string that contains the package version (for example, 3.5.2
).
Sourcepub fn set_package_version(self, input: Option<String>) -> Self
pub fn set_package_version(self, input: Option<String>) -> Self
A string that contains the package version (for example, 3.5.2
).
Sourcepub fn get_package_version(&self) -> &Option<String>
pub fn get_package_version(&self) -> &Option<String>
A string that contains the package version (for example, 3.5.2
).
Trait Implementations§
Source§impl Clone for GetPackageVersionReadmeFluentBuilder
impl Clone for GetPackageVersionReadmeFluentBuilder
Source§fn clone(&self) -> GetPackageVersionReadmeFluentBuilder
fn clone(&self) -> GetPackageVersionReadmeFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for GetPackageVersionReadmeFluentBuilder
impl !RefUnwindSafe for GetPackageVersionReadmeFluentBuilder
impl Send for GetPackageVersionReadmeFluentBuilder
impl Sync for GetPackageVersionReadmeFluentBuilder
impl Unpin for GetPackageVersionReadmeFluentBuilder
impl !UnwindSafe for GetPackageVersionReadmeFluentBuilder
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);