#[non_exhaustive]pub struct OptionSettingBuilder { /* private fields */ }
Expand description
A builder for OptionSetting
.
Implementations§
Source§impl OptionSettingBuilder
impl OptionSettingBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the option that has settings that you can set.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the option that has settings that you can set.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the option that has settings that you can set.
Sourcepub fn default_value(self, input: impl Into<String>) -> Self
pub fn default_value(self, input: impl Into<String>) -> Self
The default value of the option setting.
Sourcepub fn set_default_value(self, input: Option<String>) -> Self
pub fn set_default_value(self, input: Option<String>) -> Self
The default value of the option setting.
Sourcepub fn get_default_value(&self) -> &Option<String>
pub fn get_default_value(&self) -> &Option<String>
The default value of the option setting.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the option setting.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the option setting.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the option setting.
Sourcepub fn apply_type(self, input: impl Into<String>) -> Self
pub fn apply_type(self, input: impl Into<String>) -> Self
The DB engine specific parameter type.
Sourcepub fn set_apply_type(self, input: Option<String>) -> Self
pub fn set_apply_type(self, input: Option<String>) -> Self
The DB engine specific parameter type.
Sourcepub fn get_apply_type(&self) -> &Option<String>
pub fn get_apply_type(&self) -> &Option<String>
The DB engine specific parameter type.
Sourcepub fn set_data_type(self, input: Option<String>) -> Self
pub fn set_data_type(self, input: Option<String>) -> Self
The data type of the option setting.
Sourcepub fn get_data_type(&self) -> &Option<String>
pub fn get_data_type(&self) -> &Option<String>
The data type of the option setting.
Sourcepub fn allowed_values(self, input: impl Into<String>) -> Self
pub fn allowed_values(self, input: impl Into<String>) -> Self
The allowed values of the option setting.
Sourcepub fn set_allowed_values(self, input: Option<String>) -> Self
pub fn set_allowed_values(self, input: Option<String>) -> Self
The allowed values of the option setting.
Sourcepub fn get_allowed_values(&self) -> &Option<String>
pub fn get_allowed_values(&self) -> &Option<String>
The allowed values of the option setting.
Sourcepub fn is_modifiable(self, input: bool) -> Self
pub fn is_modifiable(self, input: bool) -> Self
Indicates whether the option setting can be modified from the default.
Sourcepub fn set_is_modifiable(self, input: Option<bool>) -> Self
pub fn set_is_modifiable(self, input: Option<bool>) -> Self
Indicates whether the option setting can be modified from the default.
Sourcepub fn get_is_modifiable(&self) -> &Option<bool>
pub fn get_is_modifiable(&self) -> &Option<bool>
Indicates whether the option setting can be modified from the default.
Sourcepub fn is_collection(self, input: bool) -> Self
pub fn is_collection(self, input: bool) -> Self
Indicates whether the option setting is part of a collection.
Sourcepub fn set_is_collection(self, input: Option<bool>) -> Self
pub fn set_is_collection(self, input: Option<bool>) -> Self
Indicates whether the option setting is part of a collection.
Sourcepub fn get_is_collection(&self) -> &Option<bool>
pub fn get_is_collection(&self) -> &Option<bool>
Indicates whether the option setting is part of a collection.
Sourcepub fn build(self) -> OptionSetting
pub fn build(self) -> OptionSetting
Consumes the builder and constructs a OptionSetting
.
Trait Implementations§
Source§impl Clone for OptionSettingBuilder
impl Clone for OptionSettingBuilder
Source§fn clone(&self) -> OptionSettingBuilder
fn clone(&self) -> OptionSettingBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OptionSettingBuilder
impl Debug for OptionSettingBuilder
Source§impl Default for OptionSettingBuilder
impl Default for OptionSettingBuilder
Source§fn default() -> OptionSettingBuilder
fn default() -> OptionSettingBuilder
Source§impl PartialEq for OptionSettingBuilder
impl PartialEq for OptionSettingBuilder
impl StructuralPartialEq for OptionSettingBuilder
Auto Trait Implementations§
impl Freeze for OptionSettingBuilder
impl RefUnwindSafe for OptionSettingBuilder
impl Send for OptionSettingBuilder
impl Sync for OptionSettingBuilder
impl Unpin for OptionSettingBuilder
impl UnwindSafe for OptionSettingBuilder
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);