#[non_exhaustive]pub struct ParameterSliderControlBuilder { /* private fields */ }
Expand description
A builder for ParameterSliderControl
.
Implementations§
Source§impl ParameterSliderControlBuilder
impl ParameterSliderControlBuilder
Sourcepub fn parameter_control_id(self, input: impl Into<String>) -> Self
pub fn parameter_control_id(self, input: impl Into<String>) -> Self
The ID of the ParameterSliderControl
.
Sourcepub fn set_parameter_control_id(self, input: Option<String>) -> Self
pub fn set_parameter_control_id(self, input: Option<String>) -> Self
The ID of the ParameterSliderControl
.
Sourcepub fn get_parameter_control_id(&self) -> &Option<String>
pub fn get_parameter_control_id(&self) -> &Option<String>
The ID of the ParameterSliderControl
.
Sourcepub fn title(self, input: impl Into<String>) -> Self
pub fn title(self, input: impl Into<String>) -> Self
The title of the ParameterSliderControl
.
Sourcepub fn source_parameter_name(self, input: impl Into<String>) -> Self
pub fn source_parameter_name(self, input: impl Into<String>) -> Self
The source parameter name of the ParameterSliderControl
.
Sourcepub fn set_source_parameter_name(self, input: Option<String>) -> Self
pub fn set_source_parameter_name(self, input: Option<String>) -> Self
The source parameter name of the ParameterSliderControl
.
Sourcepub fn get_source_parameter_name(&self) -> &Option<String>
pub fn get_source_parameter_name(&self) -> &Option<String>
The source parameter name of the ParameterSliderControl
.
Sourcepub fn display_options(self, input: SliderControlDisplayOptions) -> Self
pub fn display_options(self, input: SliderControlDisplayOptions) -> Self
The display options of a control.
Sourcepub fn set_display_options(
self,
input: Option<SliderControlDisplayOptions>,
) -> Self
pub fn set_display_options( self, input: Option<SliderControlDisplayOptions>, ) -> Self
The display options of a control.
Sourcepub fn get_display_options(&self) -> &Option<SliderControlDisplayOptions>
pub fn get_display_options(&self) -> &Option<SliderControlDisplayOptions>
The display options of a control.
Sourcepub fn maximum_value(self, input: f64) -> Self
pub fn maximum_value(self, input: f64) -> Self
The larger value that is displayed at the right of the slider.
This field is required.Sourcepub fn set_maximum_value(self, input: Option<f64>) -> Self
pub fn set_maximum_value(self, input: Option<f64>) -> Self
The larger value that is displayed at the right of the slider.
Sourcepub fn get_maximum_value(&self) -> &Option<f64>
pub fn get_maximum_value(&self) -> &Option<f64>
The larger value that is displayed at the right of the slider.
Sourcepub fn minimum_value(self, input: f64) -> Self
pub fn minimum_value(self, input: f64) -> Self
The smaller value that is displayed at the left of the slider.
This field is required.Sourcepub fn set_minimum_value(self, input: Option<f64>) -> Self
pub fn set_minimum_value(self, input: Option<f64>) -> Self
The smaller value that is displayed at the left of the slider.
Sourcepub fn get_minimum_value(&self) -> &Option<f64>
pub fn get_minimum_value(&self) -> &Option<f64>
The smaller value that is displayed at the left of the slider.
Sourcepub fn step_size(self, input: f64) -> Self
pub fn step_size(self, input: f64) -> Self
The number of increments that the slider bar is divided into.
This field is required.Sourcepub fn set_step_size(self, input: Option<f64>) -> Self
pub fn set_step_size(self, input: Option<f64>) -> Self
The number of increments that the slider bar is divided into.
Sourcepub fn get_step_size(&self) -> &Option<f64>
pub fn get_step_size(&self) -> &Option<f64>
The number of increments that the slider bar is divided into.
Sourcepub fn build(self) -> Result<ParameterSliderControl, BuildError>
pub fn build(self) -> Result<ParameterSliderControl, BuildError>
Consumes the builder and constructs a ParameterSliderControl
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ParameterSliderControlBuilder
impl Clone for ParameterSliderControlBuilder
Source§fn clone(&self) -> ParameterSliderControlBuilder
fn clone(&self) -> ParameterSliderControlBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for ParameterSliderControlBuilder
impl Default for ParameterSliderControlBuilder
Source§fn default() -> ParameterSliderControlBuilder
fn default() -> ParameterSliderControlBuilder
Source§impl PartialEq for ParameterSliderControlBuilder
impl PartialEq for ParameterSliderControlBuilder
Source§fn eq(&self, other: &ParameterSliderControlBuilder) -> bool
fn eq(&self, other: &ParameterSliderControlBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ParameterSliderControlBuilder
Auto Trait Implementations§
impl Freeze for ParameterSliderControlBuilder
impl RefUnwindSafe for ParameterSliderControlBuilder
impl Send for ParameterSliderControlBuilder
impl Sync for ParameterSliderControlBuilder
impl Unpin for ParameterSliderControlBuilder
impl UnwindSafe for ParameterSliderControlBuilder
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);