#[non_exhaustive]pub struct ChannelSummaryBuilder { /* private fields */ }
Expand description
A builder for ChannelSummary
.
Implementations§
Source§impl ChannelSummaryBuilder
impl ChannelSummaryBuilder
Sourcepub fn channel_name(self, input: impl Into<String>) -> Self
pub fn channel_name(self, input: impl Into<String>) -> Self
The name of the channel.
Sourcepub fn set_channel_name(self, input: Option<String>) -> Self
pub fn set_channel_name(self, input: Option<String>) -> Self
The name of the channel.
Sourcepub fn get_channel_name(&self) -> &Option<String>
pub fn get_channel_name(&self) -> &Option<String>
The name of the channel.
Sourcepub fn channel_storage(self, input: ChannelStorageSummary) -> Self
pub fn channel_storage(self, input: ChannelStorageSummary) -> Self
Where channel data is stored.
Sourcepub fn set_channel_storage(self, input: Option<ChannelStorageSummary>) -> Self
pub fn set_channel_storage(self, input: Option<ChannelStorageSummary>) -> Self
Where channel data is stored.
Sourcepub fn get_channel_storage(&self) -> &Option<ChannelStorageSummary>
pub fn get_channel_storage(&self) -> &Option<ChannelStorageSummary>
Where channel data is stored.
Sourcepub fn status(self, input: ChannelStatus) -> Self
pub fn status(self, input: ChannelStatus) -> Self
The status of the channel.
Sourcepub fn set_status(self, input: Option<ChannelStatus>) -> Self
pub fn set_status(self, input: Option<ChannelStatus>) -> Self
The status of the channel.
Sourcepub fn get_status(&self) -> &Option<ChannelStatus>
pub fn get_status(&self) -> &Option<ChannelStatus>
The status of the channel.
Sourcepub fn creation_time(self, input: DateTime) -> Self
pub fn creation_time(self, input: DateTime) -> Self
When the channel was created.
Sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_time(self, input: Option<DateTime>) -> Self
When the channel was created.
Sourcepub fn get_creation_time(&self) -> &Option<DateTime>
pub fn get_creation_time(&self) -> &Option<DateTime>
When the channel was created.
Sourcepub fn last_update_time(self, input: DateTime) -> Self
pub fn last_update_time(self, input: DateTime) -> Self
The last time the channel was updated.
Sourcepub fn set_last_update_time(self, input: Option<DateTime>) -> Self
pub fn set_last_update_time(self, input: Option<DateTime>) -> Self
The last time the channel was updated.
Sourcepub fn get_last_update_time(&self) -> &Option<DateTime>
pub fn get_last_update_time(&self) -> &Option<DateTime>
The last time the channel was updated.
Sourcepub fn last_message_arrival_time(self, input: DateTime) -> Self
pub fn last_message_arrival_time(self, input: DateTime) -> Self
The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime
value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
Sourcepub fn set_last_message_arrival_time(self, input: Option<DateTime>) -> Self
pub fn set_last_message_arrival_time(self, input: Option<DateTime>) -> Self
The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime
value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
Sourcepub fn get_last_message_arrival_time(&self) -> &Option<DateTime>
pub fn get_last_message_arrival_time(&self) -> &Option<DateTime>
The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime
value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
Sourcepub fn build(self) -> ChannelSummary
pub fn build(self) -> ChannelSummary
Consumes the builder and constructs a ChannelSummary
.
Trait Implementations§
Source§impl Clone for ChannelSummaryBuilder
impl Clone for ChannelSummaryBuilder
Source§fn clone(&self) -> ChannelSummaryBuilder
fn clone(&self) -> ChannelSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ChannelSummaryBuilder
impl Debug for ChannelSummaryBuilder
Source§impl Default for ChannelSummaryBuilder
impl Default for ChannelSummaryBuilder
Source§fn default() -> ChannelSummaryBuilder
fn default() -> ChannelSummaryBuilder
Source§impl PartialEq for ChannelSummaryBuilder
impl PartialEq for ChannelSummaryBuilder
impl StructuralPartialEq for ChannelSummaryBuilder
Auto Trait Implementations§
impl Freeze for ChannelSummaryBuilder
impl RefUnwindSafe for ChannelSummaryBuilder
impl Send for ChannelSummaryBuilder
impl Sync for ChannelSummaryBuilder
impl Unpin for ChannelSummaryBuilder
impl UnwindSafe for ChannelSummaryBuilder
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);