#[non_exhaustive]pub struct UpdateStateTemplateInput {
pub identifier: Option<String>,
pub description: Option<String>,
pub state_template_properties_to_add: Option<Vec<String>>,
pub state_template_properties_to_remove: Option<Vec<String>>,
pub data_extra_dimensions: Option<Vec<String>>,
pub metadata_extra_dimensions: Option<Vec<String>>,
}
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.identifier: Option<String>
The unique ID of the state template.
description: Option<String>
A brief description of the state template.
state_template_properties_to_add: Option<Vec<String>>
Add signals from which data is collected as part of the state template.
state_template_properties_to_remove: Option<Vec<String>>
Remove signals from which data is collected as part of the state template.
data_extra_dimensions: Option<Vec<String>>
A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions
field.
Default: An empty array
metadata_extra_dimensions: Option<Vec<String>>
A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.
Implementations§
Source§impl UpdateStateTemplateInput
impl UpdateStateTemplateInput
Sourcepub fn identifier(&self) -> Option<&str>
pub fn identifier(&self) -> Option<&str>
The unique ID of the state template.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A brief description of the state template.
Sourcepub fn state_template_properties_to_add(&self) -> &[String]
pub fn state_template_properties_to_add(&self) -> &[String]
Add signals from which data is collected as part of the state template.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .state_template_properties_to_add.is_none()
.
Sourcepub fn state_template_properties_to_remove(&self) -> &[String]
pub fn state_template_properties_to_remove(&self) -> &[String]
Remove signals from which data is collected as part of the state template.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .state_template_properties_to_remove.is_none()
.
Sourcepub fn data_extra_dimensions(&self) -> &[String]
pub fn data_extra_dimensions(&self) -> &[String]
A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions
field.
Default: An empty array
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .data_extra_dimensions.is_none()
.
Sourcepub fn metadata_extra_dimensions(&self) -> &[String]
pub fn metadata_extra_dimensions(&self) -> &[String]
A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make
and Vehicle.Attributes.Model
attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metadata_extra_dimensions.is_none()
.
Source§impl UpdateStateTemplateInput
impl UpdateStateTemplateInput
Sourcepub fn builder() -> UpdateStateTemplateInputBuilder
pub fn builder() -> UpdateStateTemplateInputBuilder
Creates a new builder-style object to manufacture UpdateStateTemplateInput
.
Trait Implementations§
Source§impl Clone for UpdateStateTemplateInput
impl Clone for UpdateStateTemplateInput
Source§fn clone(&self) -> UpdateStateTemplateInput
fn clone(&self) -> UpdateStateTemplateInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for UpdateStateTemplateInput
impl Debug for UpdateStateTemplateInput
Source§impl PartialEq for UpdateStateTemplateInput
impl PartialEq for UpdateStateTemplateInput
impl StructuralPartialEq for UpdateStateTemplateInput
Auto Trait Implementations§
impl Freeze for UpdateStateTemplateInput
impl RefUnwindSafe for UpdateStateTemplateInput
impl Send for UpdateStateTemplateInput
impl Sync for UpdateStateTemplateInput
impl Unpin for UpdateStateTemplateInput
impl UnwindSafe for UpdateStateTemplateInput
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);