#[non_exhaustive]pub struct ParticipantTimerConfigurationBuilder { /* private fields */ }
Expand description
A builder for ParticipantTimerConfiguration
.
Implementations§
Source§impl ParticipantTimerConfigurationBuilder
impl ParticipantTimerConfigurationBuilder
Sourcepub fn participant_role(self, input: TimerEligibleParticipantRoles) -> Self
pub fn participant_role(self, input: TimerEligibleParticipantRoles) -> Self
The role of the participant in the chat conversation.
This field is required.Sourcepub fn set_participant_role(
self,
input: Option<TimerEligibleParticipantRoles>,
) -> Self
pub fn set_participant_role( self, input: Option<TimerEligibleParticipantRoles>, ) -> Self
The role of the participant in the chat conversation.
Sourcepub fn get_participant_role(&self) -> &Option<TimerEligibleParticipantRoles>
pub fn get_participant_role(&self) -> &Option<TimerEligibleParticipantRoles>
The role of the participant in the chat conversation.
Sourcepub fn timer_type(self, input: ParticipantTimerType) -> Self
pub fn timer_type(self, input: ParticipantTimerType) -> Self
The type of timer. IDLE
indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER
indicates the timer applies to automatically disconnecting a chat participant due to idleness.
Sourcepub fn set_timer_type(self, input: Option<ParticipantTimerType>) -> Self
pub fn set_timer_type(self, input: Option<ParticipantTimerType>) -> Self
The type of timer. IDLE
indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER
indicates the timer applies to automatically disconnecting a chat participant due to idleness.
Sourcepub fn get_timer_type(&self) -> &Option<ParticipantTimerType>
pub fn get_timer_type(&self) -> &Option<ParticipantTimerType>
The type of timer. IDLE
indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER
indicates the timer applies to automatically disconnecting a chat participant due to idleness.
Sourcepub fn timer_value(self, input: ParticipantTimerValue) -> Self
pub fn timer_value(self, input: ParticipantTimerValue) -> Self
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
This field is required.Sourcepub fn set_timer_value(self, input: Option<ParticipantTimerValue>) -> Self
pub fn set_timer_value(self, input: Option<ParticipantTimerValue>) -> Self
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
Sourcepub fn get_timer_value(&self) -> &Option<ParticipantTimerValue>
pub fn get_timer_value(&self) -> &Option<ParticipantTimerValue>
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
Sourcepub fn build(self) -> Result<ParticipantTimerConfiguration, BuildError>
pub fn build(self) -> Result<ParticipantTimerConfiguration, BuildError>
Consumes the builder and constructs a ParticipantTimerConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ParticipantTimerConfigurationBuilder
impl Clone for ParticipantTimerConfigurationBuilder
Source§fn clone(&self) -> ParticipantTimerConfigurationBuilder
fn clone(&self) -> ParticipantTimerConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for ParticipantTimerConfigurationBuilder
impl Default for ParticipantTimerConfigurationBuilder
Source§fn default() -> ParticipantTimerConfigurationBuilder
fn default() -> ParticipantTimerConfigurationBuilder
Source§impl PartialEq for ParticipantTimerConfigurationBuilder
impl PartialEq for ParticipantTimerConfigurationBuilder
Source§fn eq(&self, other: &ParticipantTimerConfigurationBuilder) -> bool
fn eq(&self, other: &ParticipantTimerConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ParticipantTimerConfigurationBuilder
Auto Trait Implementations§
impl Freeze for ParticipantTimerConfigurationBuilder
impl RefUnwindSafe for ParticipantTimerConfigurationBuilder
impl Send for ParticipantTimerConfigurationBuilder
impl Sync for ParticipantTimerConfigurationBuilder
impl Unpin for ParticipantTimerConfigurationBuilder
impl UnwindSafe for ParticipantTimerConfigurationBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);