#[non_exhaustive]pub struct PolicyAttributeTypeDescriptionBuilder { /* private fields */ }
Expand description
A builder for PolicyAttributeTypeDescription
.
Implementations§
Source§impl PolicyAttributeTypeDescriptionBuilder
impl PolicyAttributeTypeDescriptionBuilder
Sourcepub fn attribute_name(self, input: impl Into<String>) -> Self
pub fn attribute_name(self, input: impl Into<String>) -> Self
The name of the attribute.
Sourcepub fn set_attribute_name(self, input: Option<String>) -> Self
pub fn set_attribute_name(self, input: Option<String>) -> Self
The name of the attribute.
Sourcepub fn get_attribute_name(&self) -> &Option<String>
pub fn get_attribute_name(&self) -> &Option<String>
The name of the attribute.
Sourcepub fn attribute_type(self, input: impl Into<String>) -> Self
pub fn attribute_type(self, input: impl Into<String>) -> Self
The type of the attribute. For example, Boolean
or Integer
.
Sourcepub fn set_attribute_type(self, input: Option<String>) -> Self
pub fn set_attribute_type(self, input: Option<String>) -> Self
The type of the attribute. For example, Boolean
or Integer
.
Sourcepub fn get_attribute_type(&self) -> &Option<String>
pub fn get_attribute_type(&self) -> &Option<String>
The type of the attribute. For example, Boolean
or Integer
.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the attribute.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the attribute.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the attribute.
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 attribute, if applicable.
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 attribute, if applicable.
Sourcepub fn get_default_value(&self) -> &Option<String>
pub fn get_default_value(&self) -> &Option<String>
The default value of the attribute, if applicable.
Sourcepub fn cardinality(self, input: impl Into<String>) -> Self
pub fn cardinality(self, input: impl Into<String>) -> Self
The cardinality of the attribute.
Valid values:
-
ONE(1) : Single value required
-
ZERO_OR_ONE(0..1) : Up to one value is allowed
-
ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed
-
ONE_OR_MORE(1..*0) : Required. Multiple values are allowed
Sourcepub fn set_cardinality(self, input: Option<String>) -> Self
pub fn set_cardinality(self, input: Option<String>) -> Self
The cardinality of the attribute.
Valid values:
-
ONE(1) : Single value required
-
ZERO_OR_ONE(0..1) : Up to one value is allowed
-
ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed
-
ONE_OR_MORE(1..*0) : Required. Multiple values are allowed
Sourcepub fn get_cardinality(&self) -> &Option<String>
pub fn get_cardinality(&self) -> &Option<String>
The cardinality of the attribute.
Valid values:
-
ONE(1) : Single value required
-
ZERO_OR_ONE(0..1) : Up to one value is allowed
-
ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed
-
ONE_OR_MORE(1..*0) : Required. Multiple values are allowed
Sourcepub fn build(self) -> PolicyAttributeTypeDescription
pub fn build(self) -> PolicyAttributeTypeDescription
Consumes the builder and constructs a PolicyAttributeTypeDescription
.
Trait Implementations§
Source§impl Clone for PolicyAttributeTypeDescriptionBuilder
impl Clone for PolicyAttributeTypeDescriptionBuilder
Source§fn clone(&self) -> PolicyAttributeTypeDescriptionBuilder
fn clone(&self) -> PolicyAttributeTypeDescriptionBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for PolicyAttributeTypeDescriptionBuilder
impl Default for PolicyAttributeTypeDescriptionBuilder
Source§fn default() -> PolicyAttributeTypeDescriptionBuilder
fn default() -> PolicyAttributeTypeDescriptionBuilder
Source§impl PartialEq for PolicyAttributeTypeDescriptionBuilder
impl PartialEq for PolicyAttributeTypeDescriptionBuilder
Source§fn eq(&self, other: &PolicyAttributeTypeDescriptionBuilder) -> bool
fn eq(&self, other: &PolicyAttributeTypeDescriptionBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for PolicyAttributeTypeDescriptionBuilder
Auto Trait Implementations§
impl Freeze for PolicyAttributeTypeDescriptionBuilder
impl RefUnwindSafe for PolicyAttributeTypeDescriptionBuilder
impl Send for PolicyAttributeTypeDescriptionBuilder
impl Sync for PolicyAttributeTypeDescriptionBuilder
impl Unpin for PolicyAttributeTypeDescriptionBuilder
impl UnwindSafe for PolicyAttributeTypeDescriptionBuilder
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);