#[non_exhaustive]pub struct Trial {
pub trial_name: Option<String>,
pub trial_arn: Option<String>,
pub display_name: Option<String>,
pub experiment_name: Option<String>,
pub source: Option<TrialSource>,
pub creation_time: Option<DateTime>,
pub created_by: Option<UserContext>,
pub last_modified_time: Option<DateTime>,
pub last_modified_by: Option<UserContext>,
pub metadata_properties: Option<MetadataProperties>,
pub tags: Option<Vec<Tag>>,
pub trial_component_summaries: Option<Vec<TrialComponentSimpleSummary>>,
}
Expand description
The properties of a trial as returned by the Search API.
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.trial_name: Option<String>
The name of the trial.
trial_arn: Option<String>
The Amazon Resource Name (ARN) of the trial.
display_name: Option<String>
The name of the trial as displayed. If DisplayName
isn't specified, TrialName
is displayed.
experiment_name: Option<String>
The name of the experiment the trial is part of.
source: Option<TrialSource>
The source of the trial.
creation_time: Option<DateTime>
When the trial was created.
created_by: Option<UserContext>
Who created the trial.
last_modified_time: Option<DateTime>
Who last modified the trial.
last_modified_by: Option<UserContext>
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
metadata_properties: Option<MetadataProperties>
Metadata properties of the tracking entity, trial, or trial component.
The list of tags that are associated with the trial. You can use Search API to search on the tags.
trial_component_summaries: Option<Vec<TrialComponentSimpleSummary>>
A list of the components associated with the trial. For each component, a summary of the component's properties is included.
Implementations§
Source§impl Trial
impl Trial
Sourcepub fn trial_name(&self) -> Option<&str>
pub fn trial_name(&self) -> Option<&str>
The name of the trial.
Sourcepub fn display_name(&self) -> Option<&str>
pub fn display_name(&self) -> Option<&str>
The name of the trial as displayed. If DisplayName
isn't specified, TrialName
is displayed.
Sourcepub fn experiment_name(&self) -> Option<&str>
pub fn experiment_name(&self) -> Option<&str>
The name of the experiment the trial is part of.
Sourcepub fn source(&self) -> Option<&TrialSource>
pub fn source(&self) -> Option<&TrialSource>
The source of the trial.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
When the trial was created.
Sourcepub fn created_by(&self) -> Option<&UserContext>
pub fn created_by(&self) -> Option<&UserContext>
Who created the trial.
Sourcepub fn last_modified_time(&self) -> Option<&DateTime>
pub fn last_modified_time(&self) -> Option<&DateTime>
Who last modified the trial.
Sourcepub fn last_modified_by(&self) -> Option<&UserContext>
pub fn last_modified_by(&self) -> Option<&UserContext>
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Sourcepub fn metadata_properties(&self) -> Option<&MetadataProperties>
pub fn metadata_properties(&self) -> Option<&MetadataProperties>
Metadata properties of the tracking entity, trial, or trial component.
The list of tags that are associated with the trial. You can use Search API to search on the tags.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn trial_component_summaries(&self) -> &[TrialComponentSimpleSummary]
pub fn trial_component_summaries(&self) -> &[TrialComponentSimpleSummary]
A list of the components associated with the trial. For each component, a summary of the component's properties is included.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .trial_component_summaries.is_none()
.
Trait Implementations§
impl StructuralPartialEq for Trial
Auto Trait Implementations§
impl Freeze for Trial
impl RefUnwindSafe for Trial
impl Send for Trial
impl Sync for Trial
impl Unpin for Trial
impl UnwindSafe for Trial
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);