#[non_exhaustive]pub struct ChoiceBuilder { /* private fields */ }
Expand description
A builder for Choice
.
Implementations§
Source§impl ChoiceBuilder
impl ChoiceBuilder
Sourcepub fn set_choice_id(self, input: Option<String>) -> Self
pub fn set_choice_id(self, input: Option<String>) -> Self
The ID of a choice.
Sourcepub fn get_choice_id(&self) -> &Option<String>
pub fn get_choice_id(&self) -> &Option<String>
The ID of a choice.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of a choice.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of a choice.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of a choice.
Sourcepub fn helpful_resource(self, input: ChoiceContent) -> Self
pub fn helpful_resource(self, input: ChoiceContent) -> Self
The helpful resource (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one helpful resource.
Sourcepub fn set_helpful_resource(self, input: Option<ChoiceContent>) -> Self
pub fn set_helpful_resource(self, input: Option<ChoiceContent>) -> Self
The helpful resource (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one helpful resource.
Sourcepub fn get_helpful_resource(&self) -> &Option<ChoiceContent>
pub fn get_helpful_resource(&self) -> &Option<ChoiceContent>
The helpful resource (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one helpful resource.
Sourcepub fn improvement_plan(self, input: ChoiceContent) -> Self
pub fn improvement_plan(self, input: ChoiceContent) -> Self
The improvement plan (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one improvement plan.
Sourcepub fn set_improvement_plan(self, input: Option<ChoiceContent>) -> Self
pub fn set_improvement_plan(self, input: Option<ChoiceContent>) -> Self
The improvement plan (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one improvement plan.
Sourcepub fn get_improvement_plan(&self) -> &Option<ChoiceContent>
pub fn get_improvement_plan(&self) -> &Option<ChoiceContent>
The improvement plan (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one improvement plan.
Sourcepub fn additional_resources(self, input: AdditionalResources) -> Self
pub fn additional_resources(self, input: AdditionalResources) -> Self
Appends an item to additional_resources
.
To override the contents of this collection use set_additional_resources
.
The additional resources for a choice in a custom lens.
A choice can have up to two additional resources: one of type HELPFUL_RESOURCE
, one of type IMPROVEMENT_PLAN
, or both.
Sourcepub fn set_additional_resources(
self,
input: Option<Vec<AdditionalResources>>,
) -> Self
pub fn set_additional_resources( self, input: Option<Vec<AdditionalResources>>, ) -> Self
The additional resources for a choice in a custom lens.
A choice can have up to two additional resources: one of type HELPFUL_RESOURCE
, one of type IMPROVEMENT_PLAN
, or both.
Sourcepub fn get_additional_resources(&self) -> &Option<Vec<AdditionalResources>>
pub fn get_additional_resources(&self) -> &Option<Vec<AdditionalResources>>
The additional resources for a choice in a custom lens.
A choice can have up to two additional resources: one of type HELPFUL_RESOURCE
, one of type IMPROVEMENT_PLAN
, or both.
Trait Implementations§
Source§impl Clone for ChoiceBuilder
impl Clone for ChoiceBuilder
Source§fn clone(&self) -> ChoiceBuilder
fn clone(&self) -> ChoiceBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ChoiceBuilder
impl Debug for ChoiceBuilder
Source§impl Default for ChoiceBuilder
impl Default for ChoiceBuilder
Source§fn default() -> ChoiceBuilder
fn default() -> ChoiceBuilder
Source§impl PartialEq for ChoiceBuilder
impl PartialEq for ChoiceBuilder
impl StructuralPartialEq for ChoiceBuilder
Auto Trait Implementations§
impl Freeze for ChoiceBuilder
impl RefUnwindSafe for ChoiceBuilder
impl Send for ChoiceBuilder
impl Sync for ChoiceBuilder
impl Unpin for ChoiceBuilder
impl UnwindSafe for ChoiceBuilder
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);