#[non_exhaustive]pub struct PrevalidationSignalBuilder { /* private fields */ }Expand description
A builder for PrevalidationSignal.
Implementations§
Source§impl PrevalidationSignalBuilder
impl PrevalidationSignalBuilder
Sourcepub fn subject_ref(self, input: impl Into<String>) -> Self
pub fn subject_ref(self, input: impl Into<String>) -> Self
What this signal is about, such as a finding or issue reference.
Sourcepub fn set_subject_ref(self, input: Option<String>) -> Self
pub fn set_subject_ref(self, input: Option<String>) -> Self
What this signal is about, such as a finding or issue reference.
Sourcepub fn get_subject_ref(&self) -> &Option<String>
pub fn get_subject_ref(&self) -> &Option<String>
What this signal is about, such as a finding or issue reference.
Sourcepub fn dimension(self, input: SignalDimension) -> Self
pub fn dimension(self, input: SignalDimension) -> Self
The axis this signal speaks to. Absent when the producer reported a dimension with no mapping yet.
Sourcepub fn set_dimension(self, input: Option<SignalDimension>) -> Self
pub fn set_dimension(self, input: Option<SignalDimension>) -> Self
The axis this signal speaks to. Absent when the producer reported a dimension with no mapping yet.
Sourcepub fn get_dimension(&self) -> &Option<SignalDimension>
pub fn get_dimension(&self) -> &Option<SignalDimension>
The axis this signal speaks to. Absent when the producer reported a dimension with no mapping yet.
Sourcepub fn signal_strength(self, input: SignalStrength) -> Self
pub fn signal_strength(self, input: SignalStrength) -> Self
The signal’s own rating. This is an input to scoring and is NOT the finding’s severity.
Sourcepub fn set_signal_strength(self, input: Option<SignalStrength>) -> Self
pub fn set_signal_strength(self, input: Option<SignalStrength>) -> Self
The signal’s own rating. This is an input to scoring and is NOT the finding’s severity.
Sourcepub fn get_signal_strength(&self) -> &Option<SignalStrength>
pub fn get_signal_strength(&self) -> &Option<SignalStrength>
The signal’s own rating. This is an input to scoring and is NOT the finding’s severity.
Sourcepub fn conclusion(self, input: impl Into<String>) -> Self
pub fn conclusion(self, input: impl Into<String>) -> Self
The producer’s conclusion.
Sourcepub fn set_conclusion(self, input: Option<String>) -> Self
pub fn set_conclusion(self, input: Option<String>) -> Self
The producer’s conclusion.
Sourcepub fn get_conclusion(&self) -> &Option<String>
pub fn get_conclusion(&self) -> &Option<String>
The producer’s conclusion.
Sourcepub fn producer_id(self, input: impl Into<String>) -> Self
pub fn producer_id(self, input: impl Into<String>) -> Self
Stable name of the producer that emitted this signal.
Sourcepub fn set_producer_id(self, input: Option<String>) -> Self
pub fn set_producer_id(self, input: Option<String>) -> Self
Stable name of the producer that emitted this signal.
Sourcepub fn get_producer_id(&self) -> &Option<String>
pub fn get_producer_id(&self) -> &Option<String>
Stable name of the producer that emitted this signal.
Sourcepub fn producer_version(self, input: impl Into<String>) -> Self
pub fn producer_version(self, input: impl Into<String>) -> Self
Version of that producer.
Sourcepub fn set_producer_version(self, input: Option<String>) -> Self
pub fn set_producer_version(self, input: Option<String>) -> Self
Version of that producer.
Sourcepub fn get_producer_version(&self) -> &Option<String>
pub fn get_producer_version(&self) -> &Option<String>
Version of that producer.
Sourcepub fn confidence(self, input: f64) -> Self
pub fn confidence(self, input: f64) -> Self
The producer’s confidence in this conclusion, on its native 0-1 scale. Absent when the stored value falls outside 0-1.
Sourcepub fn set_confidence(self, input: Option<f64>) -> Self
pub fn set_confidence(self, input: Option<f64>) -> Self
The producer’s confidence in this conclusion, on its native 0-1 scale. Absent when the stored value falls outside 0-1.
Sourcepub fn get_confidence(&self) -> &Option<f64>
pub fn get_confidence(&self) -> &Option<f64>
The producer’s confidence in this conclusion, on its native 0-1 scale. Absent when the stored value falls outside 0-1.
Sourcepub fn confidence_reasoning(self, input: SignalConfidenceReasoning) -> Self
pub fn confidence_reasoning(self, input: SignalConfidenceReasoning) -> Self
Why the producer is or is not sure, kept structured rather than prose.
Sourcepub fn set_confidence_reasoning(
self,
input: Option<SignalConfidenceReasoning>,
) -> Self
pub fn set_confidence_reasoning( self, input: Option<SignalConfidenceReasoning>, ) -> Self
Why the producer is or is not sure, kept structured rather than prose.
Sourcepub fn get_confidence_reasoning(&self) -> &Option<SignalConfidenceReasoning>
pub fn get_confidence_reasoning(&self) -> &Option<SignalConfidenceReasoning>
Why the producer is or is not sure, kept structured rather than prose.
Sourcepub fn computed(self, input: SignalComputation) -> Self
pub fn computed(self, input: SignalComputation) -> Self
The deterministic values the producer computed from its assessment.
Sourcepub fn set_computed(self, input: Option<SignalComputation>) -> Self
pub fn set_computed(self, input: Option<SignalComputation>) -> Self
The deterministic values the producer computed from its assessment.
Sourcepub fn get_computed(&self) -> &Option<SignalComputation>
pub fn get_computed(&self) -> &Option<SignalComputation>
The deterministic values the producer computed from its assessment.
Sourcepub fn preconditions(self, input: SignalPreconditions) -> Self
pub fn preconditions(self, input: SignalPreconditions) -> Self
The four exploit preconditions a likelihood signal assessed, each with the basis the producer had for it.
Sourcepub fn set_preconditions(self, input: Option<SignalPreconditions>) -> Self
pub fn set_preconditions(self, input: Option<SignalPreconditions>) -> Self
The four exploit preconditions a likelihood signal assessed, each with the basis the producer had for it.
Sourcepub fn get_preconditions(&self) -> &Option<SignalPreconditions>
pub fn get_preconditions(&self) -> &Option<SignalPreconditions>
The four exploit preconditions a likelihood signal assessed, each with the basis the producer had for it.
Sourcepub fn impact_dimensions(self, input: SignalImpactDimensions) -> Self
pub fn impact_dimensions(self, input: SignalImpactDimensions) -> Self
The three impact dimensions an impact signal assessed, each with the basis the producer had for it. These are what the computed impact band is derived from.
Sourcepub fn set_impact_dimensions(
self,
input: Option<SignalImpactDimensions>,
) -> Self
pub fn set_impact_dimensions( self, input: Option<SignalImpactDimensions>, ) -> Self
The three impact dimensions an impact signal assessed, each with the basis the producer had for it. These are what the computed impact band is derived from.
Sourcepub fn get_impact_dimensions(&self) -> &Option<SignalImpactDimensions>
pub fn get_impact_dimensions(&self) -> &Option<SignalImpactDimensions>
The three impact dimensions an impact signal assessed, each with the basis the producer had for it. These are what the computed impact band is derived from.
Sourcepub fn exploitability(self, input: SignalExploitability) -> Self
pub fn exploitability(self, input: SignalExploitability) -> Self
What validation established about exploitability, on an exploitability signal. This summarizes the verdict the signal was derived from; the proof itself is the VALIDATION_EVIDENCE artifact it cites.
Sourcepub fn set_exploitability(self, input: Option<SignalExploitability>) -> Self
pub fn set_exploitability(self, input: Option<SignalExploitability>) -> Self
What validation established about exploitability, on an exploitability signal. This summarizes the verdict the signal was derived from; the proof itself is the VALIDATION_EVIDENCE artifact it cites.
Sourcepub fn get_exploitability(&self) -> &Option<SignalExploitability>
pub fn get_exploitability(&self) -> &Option<SignalExploitability>
What validation established about exploitability, on an exploitability signal. This summarizes the verdict the signal was derived from; the proof itself is the VALIDATION_EVIDENCE artifact it cites.
Sourcepub fn build(self) -> PrevalidationSignal
pub fn build(self) -> PrevalidationSignal
Consumes the builder and constructs a PrevalidationSignal.
Trait Implementations§
Source§impl Clone for PrevalidationSignalBuilder
impl Clone for PrevalidationSignalBuilder
Source§impl Debug for PrevalidationSignalBuilder
impl Debug for PrevalidationSignalBuilder
Source§impl Default for PrevalidationSignalBuilder
impl Default for PrevalidationSignalBuilder
impl StructuralPartialEq for PrevalidationSignalBuilder
Auto Trait Implementations§
impl Freeze for PrevalidationSignalBuilder
impl RefUnwindSafe for PrevalidationSignalBuilder
impl Send for PrevalidationSignalBuilder
impl Sync for PrevalidationSignalBuilder
impl Unpin for PrevalidationSignalBuilder
impl UnsafeUnpin for PrevalidationSignalBuilder
impl UnwindSafe for PrevalidationSignalBuilder
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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>
renamed to 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);