#[non_exhaustive]pub struct EventLogEntryBuilder { /* private fields */ }
Expand description
A builder for EventLogEntry
.
Implementations§
Source§impl EventLogEntryBuilder
impl EventLogEntryBuilder
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The system-generated unique ID of the event.
This field is required.Sourcepub fn set_id(self, input: Option<String>) -> Self
pub fn set_id(self, input: Option<String>) -> Self
The system-generated unique ID of the event.
Sourcepub fn event_name(self, input: impl Into<String>) -> Self
pub fn event_name(self, input: impl Into<String>) -> Self
The name of the event.
This field is required.Sourcepub fn set_event_name(self, input: Option<String>) -> Self
pub fn set_event_name(self, input: Option<String>) -> Self
The name of the event.
Sourcepub fn get_event_name(&self) -> &Option<String>
pub fn get_event_name(&self) -> &Option<String>
The name of the event.
Sourcepub fn event_type(self, input: impl Into<String>) -> Self
pub fn event_type(self, input: impl Into<String>) -> Self
The type of the event.
This field is required.Sourcepub fn set_event_type(self, input: Option<String>) -> Self
pub fn set_event_type(self, input: Option<String>) -> Self
The type of the event.
Sourcepub fn get_event_type(&self) -> &Option<String>
pub fn get_event_type(&self) -> &Option<String>
The type of the event.
Sourcepub fn event_category(self, input: impl Into<String>) -> Self
pub fn event_category(self, input: impl Into<String>) -> Self
The category for the event.
This field is required.Sourcepub fn set_event_category(self, input: Option<String>) -> Self
pub fn set_event_category(self, input: Option<String>) -> Self
The category for the event.
Sourcepub fn get_event_category(&self) -> &Option<String>
pub fn get_event_category(&self) -> &Option<String>
The category for the event.
Sourcepub fn event_source(self, input: impl Into<String>) -> Self
pub fn event_source(self, input: impl Into<String>) -> Self
The source of the event.
This field is required.Sourcepub fn set_event_source(self, input: Option<String>) -> Self
pub fn set_event_source(self, input: Option<String>) -> Self
The source of the event.
Sourcepub fn get_event_source(&self) -> &Option<String>
pub fn get_event_source(&self) -> &Option<String>
The source of the event.
Sourcepub fn event_time(self, input: DateTime) -> Self
pub fn event_time(self, input: DateTime) -> Self
The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
This field is required.Sourcepub fn set_event_time(self, input: Option<DateTime>) -> Self
pub fn set_event_time(self, input: Option<DateTime>) -> Self
The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
Sourcepub fn get_event_time(&self) -> &Option<DateTime>
pub fn get_event_time(&self) -> &Option<DateTime>
The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
Sourcepub fn operation_type(self, input: OperationType) -> Self
pub fn operation_type(self, input: OperationType) -> Self
The type of the event.
This field is required.Sourcepub fn set_operation_type(self, input: Option<OperationType>) -> Self
pub fn set_operation_type(self, input: Option<OperationType>) -> Self
The type of the event.
Sourcepub fn get_operation_type(&self) -> &Option<OperationType>
pub fn get_operation_type(&self) -> &Option<OperationType>
The type of the event.
Sourcepub fn user_identity(self, input: UserIdentity) -> Self
pub fn user_identity(self, input: UserIdentity) -> Self
The system-generated unique ID of the user whose actions are recorded in the event.
This field is required.Sourcepub fn set_user_identity(self, input: Option<UserIdentity>) -> Self
pub fn set_user_identity(self, input: Option<UserIdentity>) -> Self
The system-generated unique ID of the user whose actions are recorded in the event.
Sourcepub fn get_user_identity(&self) -> &Option<UserIdentity>
pub fn get_user_identity(&self) -> &Option<UserIdentity>
The system-generated unique ID of the user whose actions are recorded in the event.
Sourcepub fn project_information(self, input: ProjectInformation) -> Self
pub fn project_information(self, input: ProjectInformation) -> Self
Information about the project where the event occurred.
Sourcepub fn set_project_information(self, input: Option<ProjectInformation>) -> Self
pub fn set_project_information(self, input: Option<ProjectInformation>) -> Self
Information about the project where the event occurred.
Sourcepub fn get_project_information(&self) -> &Option<ProjectInformation>
pub fn get_project_information(&self) -> &Option<ProjectInformation>
Information about the project where the event occurred.
Sourcepub fn request_id(self, input: impl Into<String>) -> Self
pub fn request_id(self, input: impl Into<String>) -> Self
The system-generated unique ID of the request.
Sourcepub fn set_request_id(self, input: Option<String>) -> Self
pub fn set_request_id(self, input: Option<String>) -> Self
The system-generated unique ID of the request.
Sourcepub fn get_request_id(&self) -> &Option<String>
pub fn get_request_id(&self) -> &Option<String>
The system-generated unique ID of the request.
Sourcepub fn request_payload(self, input: EventPayload) -> Self
pub fn request_payload(self, input: EventPayload) -> Self
Information about the payload of the request.
Sourcepub fn set_request_payload(self, input: Option<EventPayload>) -> Self
pub fn set_request_payload(self, input: Option<EventPayload>) -> Self
Information about the payload of the request.
Sourcepub fn get_request_payload(&self) -> &Option<EventPayload>
pub fn get_request_payload(&self) -> &Option<EventPayload>
Information about the payload of the request.
Sourcepub fn response_payload(self, input: EventPayload) -> Self
pub fn response_payload(self, input: EventPayload) -> Self
Information about the payload of the response, if any.
Sourcepub fn set_response_payload(self, input: Option<EventPayload>) -> Self
pub fn set_response_payload(self, input: Option<EventPayload>) -> Self
Information about the payload of the response, if any.
Sourcepub fn get_response_payload(&self) -> &Option<EventPayload>
pub fn get_response_payload(&self) -> &Option<EventPayload>
Information about the payload of the response, if any.
Sourcepub fn error_code(self, input: impl Into<String>) -> Self
pub fn error_code(self, input: impl Into<String>) -> Self
The code of the error, if any.
Sourcepub fn set_error_code(self, input: Option<String>) -> Self
pub fn set_error_code(self, input: Option<String>) -> Self
The code of the error, if any.
Sourcepub fn get_error_code(&self) -> &Option<String>
pub fn get_error_code(&self) -> &Option<String>
The code of the error, if any.
Sourcepub fn source_ip_address(self, input: impl Into<String>) -> Self
pub fn source_ip_address(self, input: impl Into<String>) -> Self
The IP address of the user whose actions are recorded in the event.
Sourcepub fn set_source_ip_address(self, input: Option<String>) -> Self
pub fn set_source_ip_address(self, input: Option<String>) -> Self
The IP address of the user whose actions are recorded in the event.
Sourcepub fn get_source_ip_address(&self) -> &Option<String>
pub fn get_source_ip_address(&self) -> &Option<String>
The IP address of the user whose actions are recorded in the event.
Sourcepub fn user_agent(self, input: impl Into<String>) -> Self
pub fn user_agent(self, input: impl Into<String>) -> Self
The user agent whose actions are recorded in the event.
Sourcepub fn set_user_agent(self, input: Option<String>) -> Self
pub fn set_user_agent(self, input: Option<String>) -> Self
The user agent whose actions are recorded in the event.
Sourcepub fn get_user_agent(&self) -> &Option<String>
pub fn get_user_agent(&self) -> &Option<String>
The user agent whose actions are recorded in the event.
Sourcepub fn build(self) -> Result<EventLogEntry, BuildError>
pub fn build(self) -> Result<EventLogEntry, BuildError>
Consumes the builder and constructs a EventLogEntry
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for EventLogEntryBuilder
impl Clone for EventLogEntryBuilder
Source§fn clone(&self) -> EventLogEntryBuilder
fn clone(&self) -> EventLogEntryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EventLogEntryBuilder
impl Debug for EventLogEntryBuilder
Source§impl Default for EventLogEntryBuilder
impl Default for EventLogEntryBuilder
Source§fn default() -> EventLogEntryBuilder
fn default() -> EventLogEntryBuilder
Source§impl PartialEq for EventLogEntryBuilder
impl PartialEq for EventLogEntryBuilder
impl StructuralPartialEq for EventLogEntryBuilder
Auto Trait Implementations§
impl Freeze for EventLogEntryBuilder
impl RefUnwindSafe for EventLogEntryBuilder
impl Send for EventLogEntryBuilder
impl Sync for EventLogEntryBuilder
impl Unpin for EventLogEntryBuilder
impl UnwindSafe for EventLogEntryBuilder
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);