#[non_exhaustive]pub struct Feature {Show 14 fields
pub arn: String,
pub name: String,
pub project: Option<String>,
pub status: FeatureStatus,
pub created_time: DateTime,
pub last_updated_time: DateTime,
pub description: Option<String>,
pub evaluation_strategy: FeatureEvaluationStrategy,
pub value_type: VariationValueType,
pub variations: Vec<Variation>,
pub default_variation: Option<String>,
pub evaluation_rules: Option<Vec<EvaluationRule>>,
pub tags: Option<HashMap<String, String>>,
pub entity_overrides: Option<HashMap<String, String>>,
}
Expand description
This structure contains information about one Evidently feature in your account.
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.arn: String
The ARN of the feature.
name: String
The name of the feature.
project: Option<String>
The name or ARN of the project that contains the feature.
status: FeatureStatus
The current state of the feature.
created_time: DateTime
The date and time that the feature is created.
last_updated_time: DateTime
The date and time that the feature was most recently updated.
description: Option<String>
The description of the feature.
evaluation_strategy: FeatureEvaluationStrategy
If this value is ALL_RULES
, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION
, the default variation is being served to all users.
value_type: VariationValueType
Defines the type of value used to define the different feature variations. For more information, see Variation types
variations: Vec<Variation>
An array of structures that contain the configuration of the feature's different variations.
default_variation: Option<String>
The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
This variation must also be listed in the variations
structure.
If you omit defaultVariation
, the first variation listed in the variations
structure is used as the default variation.
evaluation_rules: Option<Vec<EvaluationRule>>
An array of structures that define the evaluation rules for the feature.
The list of tag keys and values associated with this feature.
entity_overrides: Option<HashMap<String, String>>
A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.
For the override to be successful, the value of the key must match the entityId
used in the EvaluateFeature operation.
Implementations§
Source§impl Feature
impl Feature
Sourcepub fn project(&self) -> Option<&str>
pub fn project(&self) -> Option<&str>
The name or ARN of the project that contains the feature.
Sourcepub fn status(&self) -> &FeatureStatus
pub fn status(&self) -> &FeatureStatus
The current state of the feature.
Sourcepub fn created_time(&self) -> &DateTime
pub fn created_time(&self) -> &DateTime
The date and time that the feature is created.
Sourcepub fn last_updated_time(&self) -> &DateTime
pub fn last_updated_time(&self) -> &DateTime
The date and time that the feature was most recently updated.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the feature.
Sourcepub fn evaluation_strategy(&self) -> &FeatureEvaluationStrategy
pub fn evaluation_strategy(&self) -> &FeatureEvaluationStrategy
If this value is ALL_RULES
, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION
, the default variation is being served to all users.
Sourcepub fn value_type(&self) -> &VariationValueType
pub fn value_type(&self) -> &VariationValueType
Defines the type of value used to define the different feature variations. For more information, see Variation types
Sourcepub fn variations(&self) -> &[Variation]
pub fn variations(&self) -> &[Variation]
An array of structures that contain the configuration of the feature's different variations.
Sourcepub fn default_variation(&self) -> Option<&str>
pub fn default_variation(&self) -> Option<&str>
The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
This variation must also be listed in the variations
structure.
If you omit defaultVariation
, the first variation listed in the variations
structure is used as the default variation.
Sourcepub fn evaluation_rules(&self) -> &[EvaluationRule]
pub fn evaluation_rules(&self) -> &[EvaluationRule]
An array of structures that define the evaluation rules for the feature.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .evaluation_rules.is_none()
.
The list of tag keys and values associated with this feature.
Sourcepub fn entity_overrides(&self) -> Option<&HashMap<String, String>>
pub fn entity_overrides(&self) -> Option<&HashMap<String, String>>
A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.
For the override to be successful, the value of the key must match the entityId
used in the EvaluateFeature operation.
Trait Implementations§
impl StructuralPartialEq for Feature
Auto Trait Implementations§
impl Freeze for Feature
impl RefUnwindSafe for Feature
impl Send for Feature
impl Sync for Feature
impl Unpin for Feature
impl UnwindSafe for Feature
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);