Struct SignalPrecondition 

#[non_exhaustive]
pub struct SignalPrecondition {
    pub value: Option<bool>,
    pub basis: Option<SignalBasis>,
    pub reason: Option<String>,
    pub missing_info: Option<String>,
}

One assessed precondition with the basis behind it.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

value: Option<bool>

The producer’s determination. A Boolean rather than an enum, against the Common Terms preference for enums on extensibility grounds. The question each precondition answers is closed — is the code reachable, is configuration required, must a user other than the attacker interact — and the only third state, “not determined”, is already expressed by omitting this member, which the projection does whenever the stored value is not a bool. An enum would give two ways to say the same thing, while basis and missingInfo already qualify how firm the answer is.

basis: Option<SignalBasis>

Where the producer’s determination came from.

reason: Option<String>

The producer’s explanation.

missing_info: Option<String>

What the producer could not determine, when anything was missing.

Implementations

impl SignalPrecondition

pub fn value(&self) -> Option<bool>

The producer’s determination. A Boolean rather than an enum, against the Common Terms preference for enums on extensibility grounds. The question each precondition answers is closed — is the code reachable, is configuration required, must a user other than the attacker interact — and the only third state, “not determined”, is already expressed by omitting this member, which the projection does whenever the stored value is not a bool. An enum would give two ways to say the same thing, while basis and missingInfo already qualify how firm the answer is.

pub fn basis(&self) -> Option<&SignalBasis>

Where the producer’s determination came from.

pub fn reason(&self) -> Option<&str>

The producer’s explanation.

pub fn missing_info(&self) -> Option<&str>

What the producer could not determine, when anything was missing.

impl SignalPrecondition

pub fn builder() -> SignalPreconditionBuilder

Creates a new builder-style object to manufacture SignalPrecondition.

Trait Implementations

impl Clone for SignalPrecondition

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignalPrecondition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SignalPrecondition

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SignalPrecondition