#[non_exhaustive]pub struct ViolationEventBuilder { /* private fields */ }
Expand description
A builder for ViolationEvent
.
Implementations§
Source§impl ViolationEventBuilder
impl ViolationEventBuilder
Sourcepub fn violation_id(self, input: impl Into<String>) -> Self
pub fn violation_id(self, input: impl Into<String>) -> Self
The ID of the violation event.
Sourcepub fn set_violation_id(self, input: Option<String>) -> Self
pub fn set_violation_id(self, input: Option<String>) -> Self
The ID of the violation event.
Sourcepub fn get_violation_id(&self) -> &Option<String>
pub fn get_violation_id(&self) -> &Option<String>
The ID of the violation event.
Sourcepub fn thing_name(self, input: impl Into<String>) -> Self
pub fn thing_name(self, input: impl Into<String>) -> Self
The name of the thing responsible for the violation event.
Sourcepub fn set_thing_name(self, input: Option<String>) -> Self
pub fn set_thing_name(self, input: Option<String>) -> Self
The name of the thing responsible for the violation event.
Sourcepub fn get_thing_name(&self) -> &Option<String>
pub fn get_thing_name(&self) -> &Option<String>
The name of the thing responsible for the violation event.
Sourcepub fn security_profile_name(self, input: impl Into<String>) -> Self
pub fn security_profile_name(self, input: impl Into<String>) -> Self
The name of the security profile whose behavior was violated.
Sourcepub fn set_security_profile_name(self, input: Option<String>) -> Self
pub fn set_security_profile_name(self, input: Option<String>) -> Self
The name of the security profile whose behavior was violated.
Sourcepub fn get_security_profile_name(&self) -> &Option<String>
pub fn get_security_profile_name(&self) -> &Option<String>
The name of the security profile whose behavior was violated.
Sourcepub fn set_behavior(self, input: Option<Behavior>) -> Self
pub fn set_behavior(self, input: Option<Behavior>) -> Self
The behavior that was violated.
Sourcepub fn get_behavior(&self) -> &Option<Behavior>
pub fn get_behavior(&self) -> &Option<Behavior>
The behavior that was violated.
Sourcepub fn metric_value(self, input: MetricValue) -> Self
pub fn metric_value(self, input: MetricValue) -> Self
The value of the metric (the measurement).
Sourcepub fn set_metric_value(self, input: Option<MetricValue>) -> Self
pub fn set_metric_value(self, input: Option<MetricValue>) -> Self
The value of the metric (the measurement).
Sourcepub fn get_metric_value(&self) -> &Option<MetricValue>
pub fn get_metric_value(&self) -> &Option<MetricValue>
The value of the metric (the measurement).
Sourcepub fn violation_event_additional_info(
self,
input: ViolationEventAdditionalInfo,
) -> Self
pub fn violation_event_additional_info( self, input: ViolationEventAdditionalInfo, ) -> Self
The details of a violation event.
Sourcepub fn set_violation_event_additional_info(
self,
input: Option<ViolationEventAdditionalInfo>,
) -> Self
pub fn set_violation_event_additional_info( self, input: Option<ViolationEventAdditionalInfo>, ) -> Self
The details of a violation event.
Sourcepub fn get_violation_event_additional_info(
&self,
) -> &Option<ViolationEventAdditionalInfo>
pub fn get_violation_event_additional_info( &self, ) -> &Option<ViolationEventAdditionalInfo>
The details of a violation event.
Sourcepub fn violation_event_type(self, input: ViolationEventType) -> Self
pub fn violation_event_type(self, input: ViolationEventType) -> Self
The type of violation event.
Sourcepub fn set_violation_event_type(self, input: Option<ViolationEventType>) -> Self
pub fn set_violation_event_type(self, input: Option<ViolationEventType>) -> Self
The type of violation event.
Sourcepub fn get_violation_event_type(&self) -> &Option<ViolationEventType>
pub fn get_violation_event_type(&self) -> &Option<ViolationEventType>
The type of violation event.
Sourcepub fn verification_state(self, input: VerificationState) -> Self
pub fn verification_state(self, input: VerificationState) -> Self
The verification state of the violation (detect alarm).
Sourcepub fn set_verification_state(self, input: Option<VerificationState>) -> Self
pub fn set_verification_state(self, input: Option<VerificationState>) -> Self
The verification state of the violation (detect alarm).
Sourcepub fn get_verification_state(&self) -> &Option<VerificationState>
pub fn get_verification_state(&self) -> &Option<VerificationState>
The verification state of the violation (detect alarm).
Sourcepub fn verification_state_description(self, input: impl Into<String>) -> Self
pub fn verification_state_description(self, input: impl Into<String>) -> Self
The description of the verification state of the violation.
Sourcepub fn set_verification_state_description(self, input: Option<String>) -> Self
pub fn set_verification_state_description(self, input: Option<String>) -> Self
The description of the verification state of the violation.
Sourcepub fn get_verification_state_description(&self) -> &Option<String>
pub fn get_verification_state_description(&self) -> &Option<String>
The description of the verification state of the violation.
Sourcepub fn violation_event_time(self, input: DateTime) -> Self
pub fn violation_event_time(self, input: DateTime) -> Self
The time the violation event occurred.
Sourcepub fn set_violation_event_time(self, input: Option<DateTime>) -> Self
pub fn set_violation_event_time(self, input: Option<DateTime>) -> Self
The time the violation event occurred.
Sourcepub fn get_violation_event_time(&self) -> &Option<DateTime>
pub fn get_violation_event_time(&self) -> &Option<DateTime>
The time the violation event occurred.
Sourcepub fn build(self) -> ViolationEvent
pub fn build(self) -> ViolationEvent
Consumes the builder and constructs a ViolationEvent
.
Trait Implementations§
Source§impl Clone for ViolationEventBuilder
impl Clone for ViolationEventBuilder
Source§fn clone(&self) -> ViolationEventBuilder
fn clone(&self) -> ViolationEventBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ViolationEventBuilder
impl Debug for ViolationEventBuilder
Source§impl Default for ViolationEventBuilder
impl Default for ViolationEventBuilder
Source§fn default() -> ViolationEventBuilder
fn default() -> ViolationEventBuilder
Source§impl PartialEq for ViolationEventBuilder
impl PartialEq for ViolationEventBuilder
impl StructuralPartialEq for ViolationEventBuilder
Auto Trait Implementations§
impl Freeze for ViolationEventBuilder
impl RefUnwindSafe for ViolationEventBuilder
impl Send for ViolationEventBuilder
impl Sync for ViolationEventBuilder
impl Unpin for ViolationEventBuilder
impl UnwindSafe for ViolationEventBuilder
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);