#[non_exhaustive]pub struct EndpointSettingBuilder { /* private fields */ }
Expand description
A builder for EndpointSetting
.
Implementations§
Source§impl EndpointSettingBuilder
impl EndpointSettingBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name that you want to give the endpoint settings.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name that you want to give the endpoint settings.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name that you want to give the endpoint settings.
Sourcepub fn type(self, input: EndpointSettingTypeValue) -> Self
pub fn type(self, input: EndpointSettingTypeValue) -> Self
The type of endpoint. Valid values are source
and target
.
Sourcepub fn set_type(self, input: Option<EndpointSettingTypeValue>) -> Self
pub fn set_type(self, input: Option<EndpointSettingTypeValue>) -> Self
The type of endpoint. Valid values are source
and target
.
Sourcepub fn get_type(&self) -> &Option<EndpointSettingTypeValue>
pub fn get_type(&self) -> &Option<EndpointSettingTypeValue>
The type of endpoint. Valid values are source
and target
.
Sourcepub fn enum_values(self, input: impl Into<String>) -> Self
pub fn enum_values(self, input: impl Into<String>) -> Self
Appends an item to enum_values
.
To override the contents of this collection use set_enum_values
.
Enumerated values to use for this endpoint.
Sourcepub fn set_enum_values(self, input: Option<Vec<String>>) -> Self
pub fn set_enum_values(self, input: Option<Vec<String>>) -> Self
Enumerated values to use for this endpoint.
Sourcepub fn get_enum_values(&self) -> &Option<Vec<String>>
pub fn get_enum_values(&self) -> &Option<Vec<String>>
Enumerated values to use for this endpoint.
Sourcepub fn sensitive(self, input: bool) -> Self
pub fn sensitive(self, input: bool) -> Self
A value that marks this endpoint setting as sensitive.
Sourcepub fn set_sensitive(self, input: Option<bool>) -> Self
pub fn set_sensitive(self, input: Option<bool>) -> Self
A value that marks this endpoint setting as sensitive.
Sourcepub fn get_sensitive(&self) -> &Option<bool>
pub fn get_sensitive(&self) -> &Option<bool>
A value that marks this endpoint setting as sensitive.
Sourcepub fn units(self, input: impl Into<String>) -> Self
pub fn units(self, input: impl Into<String>) -> Self
The unit of measure for this endpoint setting.
Sourcepub fn set_units(self, input: Option<String>) -> Self
pub fn set_units(self, input: Option<String>) -> Self
The unit of measure for this endpoint setting.
Sourcepub fn applicability(self, input: impl Into<String>) -> Self
pub fn applicability(self, input: impl Into<String>) -> Self
The relevance or validity of an endpoint setting for an engine name and its endpoint type.
Sourcepub fn set_applicability(self, input: Option<String>) -> Self
pub fn set_applicability(self, input: Option<String>) -> Self
The relevance or validity of an endpoint setting for an engine name and its endpoint type.
Sourcepub fn get_applicability(&self) -> &Option<String>
pub fn get_applicability(&self) -> &Option<String>
The relevance or validity of an endpoint setting for an engine name and its endpoint type.
Sourcepub fn int_value_min(self, input: i32) -> Self
pub fn int_value_min(self, input: i32) -> Self
The minimum value of an endpoint setting that is of type int
.
Sourcepub fn set_int_value_min(self, input: Option<i32>) -> Self
pub fn set_int_value_min(self, input: Option<i32>) -> Self
The minimum value of an endpoint setting that is of type int
.
Sourcepub fn get_int_value_min(&self) -> &Option<i32>
pub fn get_int_value_min(&self) -> &Option<i32>
The minimum value of an endpoint setting that is of type int
.
Sourcepub fn int_value_max(self, input: i32) -> Self
pub fn int_value_max(self, input: i32) -> Self
The maximum value of an endpoint setting that is of type int
.
Sourcepub fn set_int_value_max(self, input: Option<i32>) -> Self
pub fn set_int_value_max(self, input: Option<i32>) -> Self
The maximum value of an endpoint setting that is of type int
.
Sourcepub fn get_int_value_max(&self) -> &Option<i32>
pub fn get_int_value_max(&self) -> &Option<i32>
The maximum value of an endpoint setting that is of type int
.
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 endpoint setting if no value is specified using CreateEndpoint
or ModifyEndpoint
.
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 endpoint setting if no value is specified using CreateEndpoint
or ModifyEndpoint
.
Sourcepub fn get_default_value(&self) -> &Option<String>
pub fn get_default_value(&self) -> &Option<String>
The default value of the endpoint setting if no value is specified using CreateEndpoint
or ModifyEndpoint
.
Sourcepub fn build(self) -> EndpointSetting
pub fn build(self) -> EndpointSetting
Consumes the builder and constructs a EndpointSetting
.
Trait Implementations§
Source§impl Clone for EndpointSettingBuilder
impl Clone for EndpointSettingBuilder
Source§fn clone(&self) -> EndpointSettingBuilder
fn clone(&self) -> EndpointSettingBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EndpointSettingBuilder
impl Debug for EndpointSettingBuilder
Source§impl Default for EndpointSettingBuilder
impl Default for EndpointSettingBuilder
Source§fn default() -> EndpointSettingBuilder
fn default() -> EndpointSettingBuilder
Source§impl PartialEq for EndpointSettingBuilder
impl PartialEq for EndpointSettingBuilder
impl StructuralPartialEq for EndpointSettingBuilder
Auto Trait Implementations§
impl Freeze for EndpointSettingBuilder
impl RefUnwindSafe for EndpointSettingBuilder
impl Send for EndpointSettingBuilder
impl Sync for EndpointSettingBuilder
impl Unpin for EndpointSettingBuilder
impl UnwindSafe for EndpointSettingBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);