Struct RuleFile 

pub struct RuleFile {
    pub path: String,
    pub name: String,
    pub label: String,
    pub premise: String,
    pub interval: String,
    pub indicators: Vec<String>,
    pub params: Vec<Fixed>,
    pub entry: String,
    pub exit: String,
    pub version: String,
    pub problem: Option<String>,
}

One file under <project>/rules/: a rule written as data (#225), as the picker sees it.

Fields

path: String

name: String

label: String

premise: String

interval: String

indicators: Vec<String>

The indicators it declares, by name.

params: Vec<Fixed>

Defaults for the numbers a ruleset’s grid may vary.

entry: String

The entry and exit conditions, read back as a sentence.

exit: String

version: String

The definition’s content hash: what a finding on it is stamped with.

problem: Option<String>

Why it cannot run, when it cannot. The rest of the fields are then empty.

Implementations

impl RuleFile

pub fn problem(&self) -> &str

Returns the value of problem, or the default value if problem is unset.

Trait Implementations

impl Clone for RuleFile

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 RuleFile

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

Formats the value using the given formatter.

impl Default for RuleFile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RuleFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RuleFile

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RuleFile

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RuleFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RuleFile