#[non_exhaustive]pub struct ParameterControlBuilder { /* private fields */ }
Expand description
A builder for ParameterControl
.
Implementations§
Source§impl ParameterControlBuilder
impl ParameterControlBuilder
Sourcepub fn date_time_picker(self, input: ParameterDateTimePickerControl) -> Self
pub fn date_time_picker(self, input: ParameterDateTimePickerControl) -> Self
A control from a date parameter that specifies date and time.
Sourcepub fn set_date_time_picker(
self,
input: Option<ParameterDateTimePickerControl>,
) -> Self
pub fn set_date_time_picker( self, input: Option<ParameterDateTimePickerControl>, ) -> Self
A control from a date parameter that specifies date and time.
Sourcepub fn get_date_time_picker(&self) -> &Option<ParameterDateTimePickerControl>
pub fn get_date_time_picker(&self) -> &Option<ParameterDateTimePickerControl>
A control from a date parameter that specifies date and time.
Sourcepub fn list(self, input: ParameterListControl) -> Self
pub fn list(self, input: ParameterListControl) -> Self
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
Sourcepub fn set_list(self, input: Option<ParameterListControl>) -> Self
pub fn set_list(self, input: Option<ParameterListControl>) -> Self
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
Sourcepub fn get_list(&self) -> &Option<ParameterListControl>
pub fn get_list(&self) -> &Option<ParameterListControl>
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
Sourcepub fn dropdown(self, input: ParameterDropDownControl) -> Self
pub fn dropdown(self, input: ParameterDropDownControl) -> Self
A control to display a dropdown list with buttons that are used to select a single value.
Sourcepub fn set_dropdown(self, input: Option<ParameterDropDownControl>) -> Self
pub fn set_dropdown(self, input: Option<ParameterDropDownControl>) -> Self
A control to display a dropdown list with buttons that are used to select a single value.
Sourcepub fn get_dropdown(&self) -> &Option<ParameterDropDownControl>
pub fn get_dropdown(&self) -> &Option<ParameterDropDownControl>
A control to display a dropdown list with buttons that are used to select a single value.
Sourcepub fn text_field(self, input: ParameterTextFieldControl) -> Self
pub fn text_field(self, input: ParameterTextFieldControl) -> Self
A control to display a text box that is used to enter a single entry.
Sourcepub fn set_text_field(self, input: Option<ParameterTextFieldControl>) -> Self
pub fn set_text_field(self, input: Option<ParameterTextFieldControl>) -> Self
A control to display a text box that is used to enter a single entry.
Sourcepub fn get_text_field(&self) -> &Option<ParameterTextFieldControl>
pub fn get_text_field(&self) -> &Option<ParameterTextFieldControl>
A control to display a text box that is used to enter a single entry.
Sourcepub fn text_area(self, input: ParameterTextAreaControl) -> Self
pub fn text_area(self, input: ParameterTextAreaControl) -> Self
A control to display a text box that is used to enter multiple entries.
Sourcepub fn set_text_area(self, input: Option<ParameterTextAreaControl>) -> Self
pub fn set_text_area(self, input: Option<ParameterTextAreaControl>) -> Self
A control to display a text box that is used to enter multiple entries.
Sourcepub fn get_text_area(&self) -> &Option<ParameterTextAreaControl>
pub fn get_text_area(&self) -> &Option<ParameterTextAreaControl>
A control to display a text box that is used to enter multiple entries.
Sourcepub fn slider(self, input: ParameterSliderControl) -> Self
pub fn slider(self, input: ParameterSliderControl) -> Self
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
Sourcepub fn set_slider(self, input: Option<ParameterSliderControl>) -> Self
pub fn set_slider(self, input: Option<ParameterSliderControl>) -> Self
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
Sourcepub fn get_slider(&self) -> &Option<ParameterSliderControl>
pub fn get_slider(&self) -> &Option<ParameterSliderControl>
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
Sourcepub fn build(self) -> ParameterControl
pub fn build(self) -> ParameterControl
Consumes the builder and constructs a ParameterControl
.
Trait Implementations§
Source§impl Clone for ParameterControlBuilder
impl Clone for ParameterControlBuilder
Source§fn clone(&self) -> ParameterControlBuilder
fn clone(&self) -> ParameterControlBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ParameterControlBuilder
impl Debug for ParameterControlBuilder
Source§impl Default for ParameterControlBuilder
impl Default for ParameterControlBuilder
Source§fn default() -> ParameterControlBuilder
fn default() -> ParameterControlBuilder
Source§impl PartialEq for ParameterControlBuilder
impl PartialEq for ParameterControlBuilder
impl StructuralPartialEq for ParameterControlBuilder
Auto Trait Implementations§
impl Freeze for ParameterControlBuilder
impl RefUnwindSafe for ParameterControlBuilder
impl Send for ParameterControlBuilder
impl Sync for ParameterControlBuilder
impl Unpin for ParameterControlBuilder
impl UnwindSafe for ParameterControlBuilder
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);