#[non_exhaustive]pub struct AuditFindingBuilder { /* private fields */ }
Expand description
A builder for AuditFinding
.
Implementations§
Source§impl AuditFindingBuilder
impl AuditFindingBuilder
Sourcepub fn key_attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn key_attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to key_attributes
.
To override the contents of this collection use set_key_attributes
.
The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.
Sourcepub fn set_key_attributes(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_key_attributes(self, input: Option<HashMap<String, String>>) -> Self
The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.
Sourcepub fn get_key_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_key_attributes(&self) -> &Option<HashMap<String, String>>
The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.
Sourcepub fn auditor_results(self, input: AuditorResult) -> Self
pub fn auditor_results(self, input: AuditorResult) -> Self
Appends an item to auditor_results
.
To override the contents of this collection use set_auditor_results
.
An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.
Sourcepub fn set_auditor_results(self, input: Option<Vec<AuditorResult>>) -> Self
pub fn set_auditor_results(self, input: Option<Vec<AuditorResult>>) -> Self
An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.
Sourcepub fn get_auditor_results(&self) -> &Option<Vec<AuditorResult>>
pub fn get_auditor_results(&self) -> &Option<Vec<AuditorResult>>
An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.
Sourcepub fn operation(self, input: impl Into<String>) -> Self
pub fn operation(self, input: impl Into<String>) -> Self
The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.
Sourcepub fn set_operation(self, input: Option<String>) -> Self
pub fn set_operation(self, input: Option<String>) -> Self
The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.
Sourcepub fn get_operation(&self) -> &Option<String>
pub fn get_operation(&self) -> &Option<String>
The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.
Sourcepub fn metric_graph(self, input: MetricGraph) -> Self
pub fn metric_graph(self, input: MetricGraph) -> Self
A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.
Sourcepub fn set_metric_graph(self, input: Option<MetricGraph>) -> Self
pub fn set_metric_graph(self, input: Option<MetricGraph>) -> Self
A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.
Sourcepub fn get_metric_graph(&self) -> &Option<MetricGraph>
pub fn get_metric_graph(&self) -> &Option<MetricGraph>
A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.
Sourcepub fn dependency_graph(self, input: DependencyGraph) -> Self
pub fn dependency_graph(self, input: DependencyGraph) -> Self
A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.
Sourcepub fn set_dependency_graph(self, input: Option<DependencyGraph>) -> Self
pub fn set_dependency_graph(self, input: Option<DependencyGraph>) -> Self
A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.
Sourcepub fn get_dependency_graph(&self) -> &Option<DependencyGraph>
pub fn get_dependency_graph(&self) -> &Option<DependencyGraph>
A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.
Sourcepub fn build(self) -> Result<AuditFinding, BuildError>
pub fn build(self) -> Result<AuditFinding, BuildError>
Consumes the builder and constructs a AuditFinding
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AuditFindingBuilder
impl Clone for AuditFindingBuilder
Source§fn clone(&self) -> AuditFindingBuilder
fn clone(&self) -> AuditFindingBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AuditFindingBuilder
impl Debug for AuditFindingBuilder
Source§impl Default for AuditFindingBuilder
impl Default for AuditFindingBuilder
Source§fn default() -> AuditFindingBuilder
fn default() -> AuditFindingBuilder
Source§impl PartialEq for AuditFindingBuilder
impl PartialEq for AuditFindingBuilder
impl StructuralPartialEq for AuditFindingBuilder
Auto Trait Implementations§
impl Freeze for AuditFindingBuilder
impl RefUnwindSafe for AuditFindingBuilder
impl Send for AuditFindingBuilder
impl Sync for AuditFindingBuilder
impl Unpin for AuditFindingBuilder
impl UnwindSafe for AuditFindingBuilder
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);