#[non_exhaustive]pub struct AuditEventBuilder { /* private fields */ }
Expand description
A builder for AuditEvent
.
Implementations§
Source§impl AuditEventBuilder
impl AuditEventBuilder
Sourcepub fn event_id(self, input: impl Into<String>) -> Self
pub fn event_id(self, input: impl Into<String>) -> Self
Unique identifier of a case audit history event.
This field is required.Sourcepub fn set_event_id(self, input: Option<String>) -> Self
pub fn set_event_id(self, input: Option<String>) -> Self
Unique identifier of a case audit history event.
Sourcepub fn get_event_id(&self) -> &Option<String>
pub fn get_event_id(&self) -> &Option<String>
Unique identifier of a case audit history event.
Sourcepub fn type(self, input: AuditEventType) -> Self
pub fn type(self, input: AuditEventType) -> Self
The Type of an audit history event.
This field is required.Sourcepub fn set_type(self, input: Option<AuditEventType>) -> Self
pub fn set_type(self, input: Option<AuditEventType>) -> Self
The Type of an audit history event.
Sourcepub fn get_type(&self) -> &Option<AuditEventType>
pub fn get_type(&self) -> &Option<AuditEventType>
The Type of an audit history event.
The Type of the related item.
The Type of the related item.
The Type of the related item.
Sourcepub fn performed_time(self, input: DateTime) -> Self
pub fn performed_time(self, input: DateTime) -> Self
Time at which an Audit History event took place.
This field is required.Sourcepub fn set_performed_time(self, input: Option<DateTime>) -> Self
pub fn set_performed_time(self, input: Option<DateTime>) -> Self
Time at which an Audit History event took place.
Sourcepub fn get_performed_time(&self) -> &Option<DateTime>
pub fn get_performed_time(&self) -> &Option<DateTime>
Time at which an Audit History event took place.
Sourcepub fn fields(self, input: Option<AuditEventField>) -> Self
pub fn fields(self, input: Option<AuditEventField>) -> Self
Appends an item to fields
.
To override the contents of this collection use set_fields
.
A list of Case Audit History event fields.
Sourcepub fn set_fields(self, input: Option<Vec<Option<AuditEventField>>>) -> Self
pub fn set_fields(self, input: Option<Vec<Option<AuditEventField>>>) -> Self
A list of Case Audit History event fields.
Sourcepub fn get_fields(&self) -> &Option<Vec<Option<AuditEventField>>>
pub fn get_fields(&self) -> &Option<Vec<Option<AuditEventField>>>
A list of Case Audit History event fields.
Sourcepub fn performed_by(self, input: AuditEventPerformedBy) -> Self
pub fn performed_by(self, input: AuditEventPerformedBy) -> Self
Information of the user which performed the audit.
Sourcepub fn set_performed_by(self, input: Option<AuditEventPerformedBy>) -> Self
pub fn set_performed_by(self, input: Option<AuditEventPerformedBy>) -> Self
Information of the user which performed the audit.
Sourcepub fn get_performed_by(&self) -> &Option<AuditEventPerformedBy>
pub fn get_performed_by(&self) -> &Option<AuditEventPerformedBy>
Information of the user which performed the audit.
Sourcepub fn build(self) -> Result<AuditEvent, BuildError>
pub fn build(self) -> Result<AuditEvent, BuildError>
Consumes the builder and constructs a AuditEvent
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AuditEventBuilder
impl Clone for AuditEventBuilder
Source§fn clone(&self) -> AuditEventBuilder
fn clone(&self) -> AuditEventBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AuditEventBuilder
impl Debug for AuditEventBuilder
Source§impl Default for AuditEventBuilder
impl Default for AuditEventBuilder
Source§fn default() -> AuditEventBuilder
fn default() -> AuditEventBuilder
Source§impl PartialEq for AuditEventBuilder
impl PartialEq for AuditEventBuilder
impl StructuralPartialEq for AuditEventBuilder
Auto Trait Implementations§
impl Freeze for AuditEventBuilder
impl RefUnwindSafe for AuditEventBuilder
impl Send for AuditEventBuilder
impl Sync for AuditEventBuilder
impl Unpin for AuditEventBuilder
impl UnwindSafe for AuditEventBuilder
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);