#[non_exhaustive]pub struct OptionBuilder { /* private fields */ }
Expand description
A builder for Option
.
Implementations§
Source§impl OptionBuilder
impl OptionBuilder
Sourcepub fn option_name(self, input: impl Into<String>) -> Self
pub fn option_name(self, input: impl Into<String>) -> Self
The name of the option.
Sourcepub fn set_option_name(self, input: Option<String>) -> Self
pub fn set_option_name(self, input: Option<String>) -> Self
The name of the option.
Sourcepub fn get_option_name(&self) -> &Option<String>
pub fn get_option_name(&self) -> &Option<String>
The name of the option.
Sourcepub fn option_description(self, input: impl Into<String>) -> Self
pub fn option_description(self, input: impl Into<String>) -> Self
The description of the option.
Sourcepub fn set_option_description(self, input: Option<String>) -> Self
pub fn set_option_description(self, input: Option<String>) -> Self
The description of the option.
Sourcepub fn get_option_description(&self) -> &Option<String>
pub fn get_option_description(&self) -> &Option<String>
The description of the option.
Sourcepub fn persistent(self, input: bool) -> Self
pub fn persistent(self, input: bool) -> Self
Indicates whether this option is persistent.
Sourcepub fn set_persistent(self, input: Option<bool>) -> Self
pub fn set_persistent(self, input: Option<bool>) -> Self
Indicates whether this option is persistent.
Sourcepub fn get_persistent(&self) -> &Option<bool>
pub fn get_persistent(&self) -> &Option<bool>
Indicates whether this option is persistent.
Sourcepub fn set_permanent(self, input: Option<bool>) -> Self
pub fn set_permanent(self, input: Option<bool>) -> Self
Indicates whether this option is permanent.
Sourcepub fn get_permanent(&self) -> &Option<bool>
pub fn get_permanent(&self) -> &Option<bool>
Indicates whether this option is permanent.
Sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
If required, the port configured for this option to use.
Sourcepub fn get_port(&self) -> &Option<i32>
pub fn get_port(&self) -> &Option<i32>
If required, the port configured for this option to use.
Sourcepub fn option_version(self, input: impl Into<String>) -> Self
pub fn option_version(self, input: impl Into<String>) -> Self
The version of the option.
Sourcepub fn set_option_version(self, input: Option<String>) -> Self
pub fn set_option_version(self, input: Option<String>) -> Self
The version of the option.
Sourcepub fn get_option_version(&self) -> &Option<String>
pub fn get_option_version(&self) -> &Option<String>
The version of the option.
Sourcepub fn option_settings(self, input: OptionSetting) -> Self
pub fn option_settings(self, input: OptionSetting) -> Self
Appends an item to option_settings
.
To override the contents of this collection use set_option_settings
.
The option settings for this option.
Sourcepub fn set_option_settings(self, input: Option<Vec<OptionSetting>>) -> Self
pub fn set_option_settings(self, input: Option<Vec<OptionSetting>>) -> Self
The option settings for this option.
Sourcepub fn get_option_settings(&self) -> &Option<Vec<OptionSetting>>
pub fn get_option_settings(&self) -> &Option<Vec<OptionSetting>>
The option settings for this option.
Sourcepub fn db_security_group_memberships(
self,
input: DbSecurityGroupMembership,
) -> Self
pub fn db_security_group_memberships( self, input: DbSecurityGroupMembership, ) -> Self
Appends an item to db_security_group_memberships
.
To override the contents of this collection use set_db_security_group_memberships
.
If the option requires access to a port, then this DB security group allows access to the port.
Sourcepub fn set_db_security_group_memberships(
self,
input: Option<Vec<DbSecurityGroupMembership>>,
) -> Self
pub fn set_db_security_group_memberships( self, input: Option<Vec<DbSecurityGroupMembership>>, ) -> Self
If the option requires access to a port, then this DB security group allows access to the port.
Sourcepub fn get_db_security_group_memberships(
&self,
) -> &Option<Vec<DbSecurityGroupMembership>>
pub fn get_db_security_group_memberships( &self, ) -> &Option<Vec<DbSecurityGroupMembership>>
If the option requires access to a port, then this DB security group allows access to the port.
Sourcepub fn vpc_security_group_memberships(
self,
input: VpcSecurityGroupMembership,
) -> Self
pub fn vpc_security_group_memberships( self, input: VpcSecurityGroupMembership, ) -> Self
Appends an item to vpc_security_group_memberships
.
To override the contents of this collection use set_vpc_security_group_memberships
.
If the option requires access to a port, then this VPC security group allows access to the port.
Sourcepub fn set_vpc_security_group_memberships(
self,
input: Option<Vec<VpcSecurityGroupMembership>>,
) -> Self
pub fn set_vpc_security_group_memberships( self, input: Option<Vec<VpcSecurityGroupMembership>>, ) -> Self
If the option requires access to a port, then this VPC security group allows access to the port.
Sourcepub fn get_vpc_security_group_memberships(
&self,
) -> &Option<Vec<VpcSecurityGroupMembership>>
pub fn get_vpc_security_group_memberships( &self, ) -> &Option<Vec<VpcSecurityGroupMembership>>
If the option requires access to a port, then this VPC security group allows access to the port.
Trait Implementations§
Source§impl Clone for OptionBuilder
impl Clone for OptionBuilder
Source§fn clone(&self) -> OptionBuilder
fn clone(&self) -> OptionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OptionBuilder
impl Debug for OptionBuilder
Source§impl Default for OptionBuilder
impl Default for OptionBuilder
Source§fn default() -> OptionBuilder
fn default() -> OptionBuilder
Source§impl PartialEq for OptionBuilder
impl PartialEq for OptionBuilder
impl StructuralPartialEq for OptionBuilder
Auto Trait Implementations§
impl Freeze for OptionBuilder
impl RefUnwindSafe for OptionBuilder
impl Send for OptionBuilder
impl Sync for OptionBuilder
impl Unpin for OptionBuilder
impl UnwindSafe for OptionBuilder
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);