#[non_exhaustive]pub struct OptionGroupOptionSetting {
pub setting_name: Option<String>,
pub setting_description: Option<String>,
pub default_value: Option<String>,
pub apply_type: Option<String>,
pub allowed_values: Option<String>,
pub is_modifiable: Option<bool>,
pub is_required: Option<bool>,
pub minimum_engine_version_per_allowed_value: Option<Vec<MinimumEngineVersionPerAllowedValue>>,
}
Expand description
Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.setting_name: Option<String>
The name of the option group option.
setting_description: Option<String>
The description of the option group option.
default_value: Option<String>
The default value for the option group option.
apply_type: Option<String>
The DB engine specific parameter type for the option group option.
allowed_values: Option<String>
Indicates the acceptable values for the option group option.
is_modifiable: Option<bool>
Indicates whether this option group option can be changed from the default value.
is_required: Option<bool>
Indicates whether a value must be specified for this option setting of the option group option.
minimum_engine_version_per_allowed_value: Option<Vec<MinimumEngineVersionPerAllowedValue>>
The minimum DB engine version required for the corresponding allowed value for this option setting.
Implementations§
Source§impl OptionGroupOptionSetting
impl OptionGroupOptionSetting
Sourcepub fn setting_name(&self) -> Option<&str>
pub fn setting_name(&self) -> Option<&str>
The name of the option group option.
Sourcepub fn setting_description(&self) -> Option<&str>
pub fn setting_description(&self) -> Option<&str>
The description of the option group option.
Sourcepub fn default_value(&self) -> Option<&str>
pub fn default_value(&self) -> Option<&str>
The default value for the option group option.
Sourcepub fn apply_type(&self) -> Option<&str>
pub fn apply_type(&self) -> Option<&str>
The DB engine specific parameter type for the option group option.
Sourcepub fn allowed_values(&self) -> Option<&str>
pub fn allowed_values(&self) -> Option<&str>
Indicates the acceptable values for the option group option.
Sourcepub fn is_modifiable(&self) -> Option<bool>
pub fn is_modifiable(&self) -> Option<bool>
Indicates whether this option group option can be changed from the default value.
Sourcepub fn is_required(&self) -> Option<bool>
pub fn is_required(&self) -> Option<bool>
Indicates whether a value must be specified for this option setting of the option group option.
Sourcepub fn minimum_engine_version_per_allowed_value(
&self,
) -> &[MinimumEngineVersionPerAllowedValue]
pub fn minimum_engine_version_per_allowed_value( &self, ) -> &[MinimumEngineVersionPerAllowedValue]
The minimum DB engine version required for the corresponding allowed value for this option setting.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .minimum_engine_version_per_allowed_value.is_none()
.
Source§impl OptionGroupOptionSetting
impl OptionGroupOptionSetting
Sourcepub fn builder() -> OptionGroupOptionSettingBuilder
pub fn builder() -> OptionGroupOptionSettingBuilder
Creates a new builder-style object to manufacture OptionGroupOptionSetting
.
Trait Implementations§
Source§impl Clone for OptionGroupOptionSetting
impl Clone for OptionGroupOptionSetting
Source§fn clone(&self) -> OptionGroupOptionSetting
fn clone(&self) -> OptionGroupOptionSetting
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OptionGroupOptionSetting
impl Debug for OptionGroupOptionSetting
Source§impl PartialEq for OptionGroupOptionSetting
impl PartialEq for OptionGroupOptionSetting
impl StructuralPartialEq for OptionGroupOptionSetting
Auto Trait Implementations§
impl Freeze for OptionGroupOptionSetting
impl RefUnwindSafe for OptionGroupOptionSetting
impl Send for OptionGroupOptionSetting
impl Sync for OptionGroupOptionSetting
impl Unpin for OptionGroupOptionSetting
impl UnwindSafe for OptionGroupOptionSetting
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);