#[non_exhaustive]pub struct ThreatBuilder { /* private fields */ }
Expand description
A builder for Threat
.
Implementations§
Source§impl ThreatBuilder
impl ThreatBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the threat.
Length Constraints: Minimum of 1 length. Maximum of 128 length.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the threat.
Length Constraints: Minimum of 1 length. Maximum of 128 length.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the threat.
Length Constraints: Minimum of 1 length. Maximum of 128 length.
Sourcepub fn severity(self, input: impl Into<String>) -> Self
pub fn severity(self, input: impl Into<String>) -> Self
The severity of the threat.
Length Constraints: Minimum of 1 length. Maximum of 128 length.
Sourcepub fn set_severity(self, input: Option<String>) -> Self
pub fn set_severity(self, input: Option<String>) -> Self
The severity of the threat.
Length Constraints: Minimum of 1 length. Maximum of 128 length.
Sourcepub fn get_severity(&self) -> &Option<String>
pub fn get_severity(&self) -> &Option<String>
The severity of the threat.
Length Constraints: Minimum of 1 length. Maximum of 128 length.
Sourcepub fn item_count(self, input: i32) -> Self
pub fn item_count(self, input: i32) -> Self
This total number of items in which the threat has been detected.
Sourcepub fn set_item_count(self, input: Option<i32>) -> Self
pub fn set_item_count(self, input: Option<i32>) -> Self
This total number of items in which the threat has been detected.
Sourcepub fn get_item_count(&self) -> &Option<i32>
pub fn get_item_count(&self) -> &Option<i32>
This total number of items in which the threat has been detected.
Sourcepub fn file_paths(self, input: FilePaths) -> Self
pub fn file_paths(self, input: FilePaths) -> Self
Appends an item to file_paths
.
To override the contents of this collection use set_file_paths
.
Provides information about the file paths that were affected by the threat.
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Sourcepub fn set_file_paths(self, input: Option<Vec<FilePaths>>) -> Self
pub fn set_file_paths(self, input: Option<Vec<FilePaths>>) -> Self
Provides information about the file paths that were affected by the threat.
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Sourcepub fn get_file_paths(&self) -> &Option<Vec<FilePaths>>
pub fn get_file_paths(&self) -> &Option<Vec<FilePaths>>
Provides information about the file paths that were affected by the threat.
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Trait Implementations§
Source§impl Clone for ThreatBuilder
impl Clone for ThreatBuilder
Source§fn clone(&self) -> ThreatBuilder
fn clone(&self) -> ThreatBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ThreatBuilder
impl Debug for ThreatBuilder
Source§impl Default for ThreatBuilder
impl Default for ThreatBuilder
Source§fn default() -> ThreatBuilder
fn default() -> ThreatBuilder
Source§impl PartialEq for ThreatBuilder
impl PartialEq for ThreatBuilder
impl StructuralPartialEq for ThreatBuilder
Auto Trait Implementations§
impl Freeze for ThreatBuilder
impl RefUnwindSafe for ThreatBuilder
impl Send for ThreatBuilder
impl Sync for ThreatBuilder
impl Unpin for ThreatBuilder
impl UnwindSafe for ThreatBuilder
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);