#[non_exhaustive]pub struct RecommendedActionBuilder { /* private fields */ }
Expand description
A builder for RecommendedAction
.
Implementations§
Source§impl RecommendedActionBuilder
impl RecommendedActionBuilder
Sourcepub fn action_id(self, input: impl Into<String>) -> Self
pub fn action_id(self, input: impl Into<String>) -> Self
The unique identifier of the recommended action.
Sourcepub fn set_action_id(self, input: Option<String>) -> Self
pub fn set_action_id(self, input: Option<String>) -> Self
The unique identifier of the recommended action.
Sourcepub fn get_action_id(&self) -> &Option<String>
pub fn get_action_id(&self) -> &Option<String>
The unique identifier of the recommended action.
Sourcepub fn title(self, input: impl Into<String>) -> Self
pub fn title(self, input: impl Into<String>) -> Self
A short description to summarize the action. The description might contain markdown.
Sourcepub fn set_title(self, input: Option<String>) -> Self
pub fn set_title(self, input: Option<String>) -> Self
A short description to summarize the action. The description might contain markdown.
Sourcepub fn get_title(&self) -> &Option<String>
pub fn get_title(&self) -> &Option<String>
A short description to summarize the action. The description might contain markdown.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A detailed description of the action. The description might contain markdown.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A detailed description of the action. The description might contain markdown.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A detailed description of the action. The description might contain markdown.
Sourcepub fn set_operation(self, input: Option<String>) -> Self
pub fn set_operation(self, input: Option<String>) -> Self
An API operation for the action.
Sourcepub fn get_operation(&self) -> &Option<String>
pub fn get_operation(&self) -> &Option<String>
An API operation for the action.
Sourcepub fn parameters(self, input: RecommendedActionParameter) -> Self
pub fn parameters(self, input: RecommendedActionParameter) -> Self
Appends an item to parameters
.
To override the contents of this collection use set_parameters
.
The parameters for the API operation.
Sourcepub fn set_parameters(
self,
input: Option<Vec<RecommendedActionParameter>>,
) -> Self
pub fn set_parameters( self, input: Option<Vec<RecommendedActionParameter>>, ) -> Self
The parameters for the API operation.
Sourcepub fn get_parameters(&self) -> &Option<Vec<RecommendedActionParameter>>
pub fn get_parameters(&self) -> &Option<Vec<RecommendedActionParameter>>
The parameters for the API operation.
Sourcepub fn apply_modes(self, input: impl Into<String>) -> Self
pub fn apply_modes(self, input: impl Into<String>) -> Self
Appends an item to apply_modes
.
To override the contents of this collection use set_apply_modes
.
The methods to apply the recommended action.
Valid values:
-
manual
- The action requires you to resolve the recommendation manually. -
immediately
- The action is applied immediately. -
next-maintainance-window
- The action is applied during the next scheduled maintainance.
Sourcepub fn set_apply_modes(self, input: Option<Vec<String>>) -> Self
pub fn set_apply_modes(self, input: Option<Vec<String>>) -> Self
The methods to apply the recommended action.
Valid values:
-
manual
- The action requires you to resolve the recommendation manually. -
immediately
- The action is applied immediately. -
next-maintainance-window
- The action is applied during the next scheduled maintainance.
Sourcepub fn get_apply_modes(&self) -> &Option<Vec<String>>
pub fn get_apply_modes(&self) -> &Option<Vec<String>>
The methods to apply the recommended action.
Valid values:
-
manual
- The action requires you to resolve the recommendation manually. -
immediately
- The action is applied immediately. -
next-maintainance-window
- The action is applied during the next scheduled maintainance.
Sourcepub fn status(self, input: impl Into<String>) -> Self
pub fn status(self, input: impl Into<String>) -> Self
The status of the action.
-
ready
-
applied
-
scheduled
-
resolved
Sourcepub fn set_status(self, input: Option<String>) -> Self
pub fn set_status(self, input: Option<String>) -> Self
The status of the action.
-
ready
-
applied
-
scheduled
-
resolved
Sourcepub fn get_status(&self) -> &Option<String>
pub fn get_status(&self) -> &Option<String>
The status of the action.
-
ready
-
applied
-
scheduled
-
resolved
Sourcepub fn issue_details(self, input: IssueDetails) -> Self
pub fn issue_details(self, input: IssueDetails) -> Self
The details of the issue.
Sourcepub fn set_issue_details(self, input: Option<IssueDetails>) -> Self
pub fn set_issue_details(self, input: Option<IssueDetails>) -> Self
The details of the issue.
Sourcepub fn get_issue_details(&self) -> &Option<IssueDetails>
pub fn get_issue_details(&self) -> &Option<IssueDetails>
The details of the issue.
Sourcepub fn context_attributes(self, input: ContextAttribute) -> Self
pub fn context_attributes(self, input: ContextAttribute) -> Self
Appends an item to context_attributes
.
To override the contents of this collection use set_context_attributes
.
The supporting attributes to explain the recommended action.
Sourcepub fn set_context_attributes(
self,
input: Option<Vec<ContextAttribute>>,
) -> Self
pub fn set_context_attributes( self, input: Option<Vec<ContextAttribute>>, ) -> Self
The supporting attributes to explain the recommended action.
Sourcepub fn get_context_attributes(&self) -> &Option<Vec<ContextAttribute>>
pub fn get_context_attributes(&self) -> &Option<Vec<ContextAttribute>>
The supporting attributes to explain the recommended action.
Sourcepub fn build(self) -> RecommendedAction
pub fn build(self) -> RecommendedAction
Consumes the builder and constructs a RecommendedAction
.
Trait Implementations§
Source§impl Clone for RecommendedActionBuilder
impl Clone for RecommendedActionBuilder
Source§fn clone(&self) -> RecommendedActionBuilder
fn clone(&self) -> RecommendedActionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RecommendedActionBuilder
impl Debug for RecommendedActionBuilder
Source§impl Default for RecommendedActionBuilder
impl Default for RecommendedActionBuilder
Source§fn default() -> RecommendedActionBuilder
fn default() -> RecommendedActionBuilder
Source§impl PartialEq for RecommendedActionBuilder
impl PartialEq for RecommendedActionBuilder
impl StructuralPartialEq for RecommendedActionBuilder
Auto Trait Implementations§
impl Freeze for RecommendedActionBuilder
impl RefUnwindSafe for RecommendedActionBuilder
impl Send for RecommendedActionBuilder
impl Sync for RecommendedActionBuilder
impl Unpin for RecommendedActionBuilder
impl UnwindSafe for RecommendedActionBuilder
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);