#[non_exhaustive]pub struct MetricsSummaryBuilder { /* private fields */ }
Expand description
A builder for MetricsSummary
.
Implementations§
Source§impl MetricsSummaryBuilder
impl MetricsSummaryBuilder
Sourcepub fn date(self, input: DateTime) -> Self
pub fn date(self, input: DateTime) -> Self
The date from which the metrics summary information was retrieved.
Sourcepub fn set_date(self, input: Option<DateTime>) -> Self
pub fn set_date(self, input: Option<DateTime>) -> Self
The date from which the metrics summary information was retrieved.
Sourcepub fn get_date(&self) -> &Option<DateTime>
pub fn get_date(&self) -> &Option<DateTime>
The date from which the metrics summary information was retrieved.
Sourcepub fn open_findings(self, input: FindingMetricsValuePerSeverity) -> Self
pub fn open_findings(self, input: FindingMetricsValuePerSeverity) -> Self
The number of open findings of each severity.
Sourcepub fn set_open_findings(
self,
input: Option<FindingMetricsValuePerSeverity>,
) -> Self
pub fn set_open_findings( self, input: Option<FindingMetricsValuePerSeverity>, ) -> Self
The number of open findings of each severity.
Sourcepub fn get_open_findings(&self) -> &Option<FindingMetricsValuePerSeverity>
pub fn get_open_findings(&self) -> &Option<FindingMetricsValuePerSeverity>
The number of open findings of each severity.
Sourcepub fn categories_with_most_findings(
self,
input: CategoryWithFindingNum,
) -> Self
pub fn categories_with_most_findings( self, input: CategoryWithFindingNum, ) -> Self
Appends an item to categories_with_most_findings
.
To override the contents of this collection use set_categories_with_most_findings
.
A list of CategoryWithFindingNum
objects for the top 5 finding categories with the most findings.
Sourcepub fn set_categories_with_most_findings(
self,
input: Option<Vec<CategoryWithFindingNum>>,
) -> Self
pub fn set_categories_with_most_findings( self, input: Option<Vec<CategoryWithFindingNum>>, ) -> Self
A list of CategoryWithFindingNum
objects for the top 5 finding categories with the most findings.
Sourcepub fn get_categories_with_most_findings(
&self,
) -> &Option<Vec<CategoryWithFindingNum>>
pub fn get_categories_with_most_findings( &self, ) -> &Option<Vec<CategoryWithFindingNum>>
A list of CategoryWithFindingNum
objects for the top 5 finding categories with the most findings.
Sourcepub fn scans_with_most_open_findings(
self,
input: ScanNameWithFindingNum,
) -> Self
pub fn scans_with_most_open_findings( self, input: ScanNameWithFindingNum, ) -> Self
Appends an item to scans_with_most_open_findings
.
To override the contents of this collection use set_scans_with_most_open_findings
.
A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open findings.
Sourcepub fn set_scans_with_most_open_findings(
self,
input: Option<Vec<ScanNameWithFindingNum>>,
) -> Self
pub fn set_scans_with_most_open_findings( self, input: Option<Vec<ScanNameWithFindingNum>>, ) -> Self
A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open findings.
Sourcepub fn get_scans_with_most_open_findings(
&self,
) -> &Option<Vec<ScanNameWithFindingNum>>
pub fn get_scans_with_most_open_findings( &self, ) -> &Option<Vec<ScanNameWithFindingNum>>
A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open findings.
Sourcepub fn scans_with_most_open_critical_findings(
self,
input: ScanNameWithFindingNum,
) -> Self
pub fn scans_with_most_open_critical_findings( self, input: ScanNameWithFindingNum, ) -> Self
Appends an item to scans_with_most_open_critical_findings
.
To override the contents of this collection use set_scans_with_most_open_critical_findings
.
A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open critical findings.
Sourcepub fn set_scans_with_most_open_critical_findings(
self,
input: Option<Vec<ScanNameWithFindingNum>>,
) -> Self
pub fn set_scans_with_most_open_critical_findings( self, input: Option<Vec<ScanNameWithFindingNum>>, ) -> Self
A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open critical findings.
Sourcepub fn get_scans_with_most_open_critical_findings(
&self,
) -> &Option<Vec<ScanNameWithFindingNum>>
pub fn get_scans_with_most_open_critical_findings( &self, ) -> &Option<Vec<ScanNameWithFindingNum>>
A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open critical findings.
Sourcepub fn build(self) -> MetricsSummary
pub fn build(self) -> MetricsSummary
Consumes the builder and constructs a MetricsSummary
.
Trait Implementations§
Source§impl Clone for MetricsSummaryBuilder
impl Clone for MetricsSummaryBuilder
Source§fn clone(&self) -> MetricsSummaryBuilder
fn clone(&self) -> MetricsSummaryBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MetricsSummaryBuilder
impl Debug for MetricsSummaryBuilder
Source§impl Default for MetricsSummaryBuilder
impl Default for MetricsSummaryBuilder
Source§fn default() -> MetricsSummaryBuilder
fn default() -> MetricsSummaryBuilder
Source§impl PartialEq for MetricsSummaryBuilder
impl PartialEq for MetricsSummaryBuilder
impl StructuralPartialEq for MetricsSummaryBuilder
Auto Trait Implementations§
impl Freeze for MetricsSummaryBuilder
impl RefUnwindSafe for MetricsSummaryBuilder
impl Send for MetricsSummaryBuilder
impl Sync for MetricsSummaryBuilder
impl Unpin for MetricsSummaryBuilder
impl UnwindSafe for MetricsSummaryBuilder
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);