#[non_exhaustive]pub struct RecommendationTriggerBuilder { /* private fields */ }
Expand description
A builder for RecommendationTrigger
.
Implementations§
Source§impl RecommendationTriggerBuilder
impl RecommendationTriggerBuilder
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The identifier of the recommendation trigger.
This field is required.Sourcepub fn set_id(self, input: Option<String>) -> Self
pub fn set_id(self, input: Option<String>) -> Self
The identifier of the recommendation trigger.
Sourcepub fn type(self, input: RecommendationTriggerType) -> Self
pub fn type(self, input: RecommendationTriggerType) -> Self
The type of recommendation trigger.
This field is required.Sourcepub fn set_type(self, input: Option<RecommendationTriggerType>) -> Self
pub fn set_type(self, input: Option<RecommendationTriggerType>) -> Self
The type of recommendation trigger.
Sourcepub fn get_type(&self) -> &Option<RecommendationTriggerType>
pub fn get_type(&self) -> &Option<RecommendationTriggerType>
The type of recommendation trigger.
Sourcepub fn source(self, input: RecommendationSourceType) -> Self
pub fn source(self, input: RecommendationSourceType) -> Self
The source of the recommendation trigger.
-
ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
-
RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
Sourcepub fn set_source(self, input: Option<RecommendationSourceType>) -> Self
pub fn set_source(self, input: Option<RecommendationSourceType>) -> Self
The source of the recommendation trigger.
-
ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
-
RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
Sourcepub fn get_source(&self) -> &Option<RecommendationSourceType>
pub fn get_source(&self) -> &Option<RecommendationSourceType>
The source of the recommendation trigger.
-
ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
-
RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
Sourcepub fn data(self, input: RecommendationTriggerData) -> Self
pub fn data(self, input: RecommendationTriggerData) -> Self
A union type containing information related to the trigger.
This field is required.Sourcepub fn set_data(self, input: Option<RecommendationTriggerData>) -> Self
pub fn set_data(self, input: Option<RecommendationTriggerData>) -> Self
A union type containing information related to the trigger.
Sourcepub fn get_data(&self) -> &Option<RecommendationTriggerData>
pub fn get_data(&self) -> &Option<RecommendationTriggerData>
A union type containing information related to the trigger.
Sourcepub fn recommendation_ids(self, input: impl Into<String>) -> Self
pub fn recommendation_ids(self, input: impl Into<String>) -> Self
Appends an item to recommendation_ids
.
To override the contents of this collection use set_recommendation_ids
.
The identifiers of the recommendations.
Sourcepub fn set_recommendation_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_recommendation_ids(self, input: Option<Vec<String>>) -> Self
The identifiers of the recommendations.
Sourcepub fn get_recommendation_ids(&self) -> &Option<Vec<String>>
pub fn get_recommendation_ids(&self) -> &Option<Vec<String>>
The identifiers of the recommendations.
Sourcepub fn build(self) -> Result<RecommendationTrigger, BuildError>
pub fn build(self) -> Result<RecommendationTrigger, BuildError>
Consumes the builder and constructs a RecommendationTrigger
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for RecommendationTriggerBuilder
impl Clone for RecommendationTriggerBuilder
Source§fn clone(&self) -> RecommendationTriggerBuilder
fn clone(&self) -> RecommendationTriggerBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RecommendationTriggerBuilder
impl Debug for RecommendationTriggerBuilder
Source§impl Default for RecommendationTriggerBuilder
impl Default for RecommendationTriggerBuilder
Source§fn default() -> RecommendationTriggerBuilder
fn default() -> RecommendationTriggerBuilder
Source§impl PartialEq for RecommendationTriggerBuilder
impl PartialEq for RecommendationTriggerBuilder
Source§fn eq(&self, other: &RecommendationTriggerBuilder) -> bool
fn eq(&self, other: &RecommendationTriggerBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for RecommendationTriggerBuilder
Auto Trait Implementations§
impl Freeze for RecommendationTriggerBuilder
impl RefUnwindSafe for RecommendationTriggerBuilder
impl Send for RecommendationTriggerBuilder
impl Sync for RecommendationTriggerBuilder
impl Unpin for RecommendationTriggerBuilder
impl UnwindSafe for RecommendationTriggerBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);