#[non_exhaustive]pub struct ThingDocumentBuilder { /* private fields */ }
Expand description
A builder for ThingDocument
.
Implementations§
Source§impl ThingDocumentBuilder
impl ThingDocumentBuilder
Sourcepub fn thing_name(self, input: impl Into<String>) -> Self
pub fn thing_name(self, input: impl Into<String>) -> Self
The thing name.
Sourcepub fn set_thing_name(self, input: Option<String>) -> Self
pub fn set_thing_name(self, input: Option<String>) -> Self
The thing name.
Sourcepub fn get_thing_name(&self) -> &Option<String>
pub fn get_thing_name(&self) -> &Option<String>
The thing name.
Sourcepub fn set_thing_id(self, input: Option<String>) -> Self
pub fn set_thing_id(self, input: Option<String>) -> Self
The thing ID.
Sourcepub fn get_thing_id(&self) -> &Option<String>
pub fn get_thing_id(&self) -> &Option<String>
The thing ID.
Sourcepub fn thing_type_name(self, input: impl Into<String>) -> Self
pub fn thing_type_name(self, input: impl Into<String>) -> Self
The thing type name.
Sourcepub fn set_thing_type_name(self, input: Option<String>) -> Self
pub fn set_thing_type_name(self, input: Option<String>) -> Self
The thing type name.
Sourcepub fn get_thing_type_name(&self) -> &Option<String>
pub fn get_thing_type_name(&self) -> &Option<String>
The thing type name.
Sourcepub fn thing_group_names(self, input: impl Into<String>) -> Self
pub fn thing_group_names(self, input: impl Into<String>) -> Self
Appends an item to thing_group_names
.
To override the contents of this collection use set_thing_group_names
.
Thing group and billing group names.
Sourcepub fn set_thing_group_names(self, input: Option<Vec<String>>) -> Self
pub fn set_thing_group_names(self, input: Option<Vec<String>>) -> Self
Thing group and billing group names.
Sourcepub fn get_thing_group_names(&self) -> &Option<Vec<String>>
pub fn get_thing_group_names(&self) -> &Option<Vec<String>>
Thing group and billing group names.
Sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to attributes
.
To override the contents of this collection use set_attributes
.
The attributes.
Sourcepub fn shadow(self, input: impl Into<String>) -> Self
pub fn shadow(self, input: impl Into<String>) -> Self
The unnamed shadow and named shadow.
For more information about shadows, see IoT Device Shadow service.
Sourcepub fn set_shadow(self, input: Option<String>) -> Self
pub fn set_shadow(self, input: Option<String>) -> Self
The unnamed shadow and named shadow.
For more information about shadows, see IoT Device Shadow service.
Sourcepub fn get_shadow(&self) -> &Option<String>
pub fn get_shadow(&self) -> &Option<String>
The unnamed shadow and named shadow.
For more information about shadows, see IoT Device Shadow service.
Sourcepub fn device_defender(self, input: impl Into<String>) -> Self
pub fn device_defender(self, input: impl Into<String>) -> Self
Contains Device Defender data.
For more information about Device Defender, see Device Defender.
Sourcepub fn set_device_defender(self, input: Option<String>) -> Self
pub fn set_device_defender(self, input: Option<String>) -> Self
Contains Device Defender data.
For more information about Device Defender, see Device Defender.
Sourcepub fn get_device_defender(&self) -> &Option<String>
pub fn get_device_defender(&self) -> &Option<String>
Contains Device Defender data.
For more information about Device Defender, see Device Defender.
Sourcepub fn connectivity(self, input: ThingConnectivity) -> Self
pub fn connectivity(self, input: ThingConnectivity) -> Self
Indicates whether the thing is connected to the Amazon Web Services IoT Core service.
Sourcepub fn set_connectivity(self, input: Option<ThingConnectivity>) -> Self
pub fn set_connectivity(self, input: Option<ThingConnectivity>) -> Self
Indicates whether the thing is connected to the Amazon Web Services IoT Core service.
Sourcepub fn get_connectivity(&self) -> &Option<ThingConnectivity>
pub fn get_connectivity(&self) -> &Option<ThingConnectivity>
Indicates whether the thing is connected to the Amazon Web Services IoT Core service.
Sourcepub fn build(self) -> ThingDocument
pub fn build(self) -> ThingDocument
Consumes the builder and constructs a ThingDocument
.
Trait Implementations§
Source§impl Clone for ThingDocumentBuilder
impl Clone for ThingDocumentBuilder
Source§fn clone(&self) -> ThingDocumentBuilder
fn clone(&self) -> ThingDocumentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ThingDocumentBuilder
impl Debug for ThingDocumentBuilder
Source§impl Default for ThingDocumentBuilder
impl Default for ThingDocumentBuilder
Source§fn default() -> ThingDocumentBuilder
fn default() -> ThingDocumentBuilder
Source§impl PartialEq for ThingDocumentBuilder
impl PartialEq for ThingDocumentBuilder
impl StructuralPartialEq for ThingDocumentBuilder
Auto Trait Implementations§
impl Freeze for ThingDocumentBuilder
impl RefUnwindSafe for ThingDocumentBuilder
impl Send for ThingDocumentBuilder
impl Sync for ThingDocumentBuilder
impl Unpin for ThingDocumentBuilder
impl UnwindSafe for ThingDocumentBuilder
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);