#[non_exhaustive]pub enum ConfigurationOptions {
Boolean(BooleanConfigurationOptions),
Double(DoubleConfigurationOptions),
Enum(EnumConfigurationOptions),
EnumList(EnumListConfigurationOptions),
Integer(IntegerConfigurationOptions),
IntegerList(IntegerListConfigurationOptions),
String(StringConfigurationOptions),
StringList(StringListConfigurationOptions),
Unknown,
}
Expand description
The options for customizing a security control parameter.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Boolean(BooleanConfigurationOptions)
The options for customizing a security control parameter that is a boolean. For a boolean parameter, the options are true
and false
.
Double(DoubleConfigurationOptions)
The options for customizing a security control parameter that is a double.
Enum(EnumConfigurationOptions)
The options for customizing a security control parameter that is an enum.
EnumList(EnumListConfigurationOptions)
The options for customizing a security control parameter that is a list of enums.
Integer(IntegerConfigurationOptions)
The options for customizing a security control parameter that is an integer.
IntegerList(IntegerListConfigurationOptions)
The options for customizing a security control parameter that is a list of integers.
String(StringConfigurationOptions)
The options for customizing a security control parameter that is a string data type.
StringList(StringListConfigurationOptions)
The options for customizing a security control parameter that is a list of strings.
Unknown
The Unknown
variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version.
An unknown enum variant
Note: If you encounter this error, consider upgrading your SDK to the latest version.
The Unknown
variant represents cases where the server sent a value that wasn’t recognized
by the client. This can happen when the server adds new functionality, but the client has not been updated.
To investigate this, consider turning on debug logging to print the raw HTTP response.
Implementations§
Source§impl ConfigurationOptions
impl ConfigurationOptions
Sourcepub fn as_boolean(&self) -> Result<&BooleanConfigurationOptions, &Self>
pub fn as_boolean(&self) -> Result<&BooleanConfigurationOptions, &Self>
Tries to convert the enum instance into Boolean
, extracting the inner BooleanConfigurationOptions
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_boolean(&self) -> bool
pub fn is_boolean(&self) -> bool
Returns true if this is a Boolean
.
Sourcepub fn as_double(&self) -> Result<&DoubleConfigurationOptions, &Self>
pub fn as_double(&self) -> Result<&DoubleConfigurationOptions, &Self>
Tries to convert the enum instance into Double
, extracting the inner DoubleConfigurationOptions
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn as_enum(&self) -> Result<&EnumConfigurationOptions, &Self>
pub fn as_enum(&self) -> Result<&EnumConfigurationOptions, &Self>
Tries to convert the enum instance into Enum
, extracting the inner EnumConfigurationOptions
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn as_enum_list(&self) -> Result<&EnumListConfigurationOptions, &Self>
pub fn as_enum_list(&self) -> Result<&EnumListConfigurationOptions, &Self>
Tries to convert the enum instance into EnumList
, extracting the inner EnumListConfigurationOptions
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_enum_list(&self) -> bool
pub fn is_enum_list(&self) -> bool
Returns true if this is a EnumList
.
Sourcepub fn as_integer(&self) -> Result<&IntegerConfigurationOptions, &Self>
pub fn as_integer(&self) -> Result<&IntegerConfigurationOptions, &Self>
Tries to convert the enum instance into Integer
, extracting the inner IntegerConfigurationOptions
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_integer(&self) -> bool
pub fn is_integer(&self) -> bool
Returns true if this is a Integer
.
Sourcepub fn as_integer_list(&self) -> Result<&IntegerListConfigurationOptions, &Self>
pub fn as_integer_list(&self) -> Result<&IntegerListConfigurationOptions, &Self>
Tries to convert the enum instance into IntegerList
, extracting the inner IntegerListConfigurationOptions
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_integer_list(&self) -> bool
pub fn is_integer_list(&self) -> bool
Returns true if this is a IntegerList
.
Sourcepub fn as_string(&self) -> Result<&StringConfigurationOptions, &Self>
pub fn as_string(&self) -> Result<&StringConfigurationOptions, &Self>
Tries to convert the enum instance into String
, extracting the inner StringConfigurationOptions
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn as_string_list(&self) -> Result<&StringListConfigurationOptions, &Self>
pub fn as_string_list(&self) -> Result<&StringListConfigurationOptions, &Self>
Tries to convert the enum instance into StringList
, extracting the inner StringListConfigurationOptions
.
Returns Err(&Self)
if it can’t be converted.
Sourcepub fn is_string_list(&self) -> bool
pub fn is_string_list(&self) -> bool
Returns true if this is a StringList
.
Sourcepub fn is_unknown(&self) -> bool
pub fn is_unknown(&self) -> bool
Returns true if the enum instance is the Unknown
variant.
Trait Implementations§
Source§impl Clone for ConfigurationOptions
impl Clone for ConfigurationOptions
Source§fn clone(&self) -> ConfigurationOptions
fn clone(&self) -> ConfigurationOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ConfigurationOptions
impl Debug for ConfigurationOptions
Source§impl PartialEq for ConfigurationOptions
impl PartialEq for ConfigurationOptions
impl StructuralPartialEq for ConfigurationOptions
Auto Trait Implementations§
impl Freeze for ConfigurationOptions
impl RefUnwindSafe for ConfigurationOptions
impl Send for ConfigurationOptions
impl Sync for ConfigurationOptions
impl Unpin for ConfigurationOptions
impl UnwindSafe for ConfigurationOptions
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);