Struct CompanionSpec 

pub struct CompanionSpec {
    pub name: String,
    pub regex: String,
    pub within_lines: usize,
    pub within_bytes: Option<usize>,
    pub direction: EvidenceDirection,
    pub scope: EvidenceScope,
    pub requirement: EvidenceRequirement,
    pub capture_group: Option<usize>,
    pub value_relation: EvidenceValueRelation,
    pub required: bool,
}

Secondary pattern used to confirm a primary match or provide extra context.

Fields

name: String

Field name used in verification templates (e.g. `{{companion.secret_key}}`).

regex: String

Regex to find the companion value nearby. The owning detector TOML defines its exact semantics; loading never rewrites the expression.

within_lines: usize

Maximum line distance from the primary match.

within_bytes: Option<usize>

Optional maximum byte gap between the evidence and primary spans.

direction: EvidenceDirection

Direction in which the evidence must occur.

scope: EvidenceScope

Structural boundary that both evidence and primary spans must share.

requirement: EvidenceRequirement

Admission effect of a present or absent evidence match.

capture_group: Option<usize>

Explicit regex capture group whose bytes become the evidence value.

None preserves the existing rule: select group 1 when the regex has a capture, otherwise select the whole match. Group 0 explicitly selects the whole match even when captures exist.

value_relation: EvidenceValueRelation

Exact relationship required between the selected evidence and primary values.

required: bool

Schema-v2 compatibility input. New detector corpora use requirement = "required" instead.

Implementations

impl CompanionSpec

pub fn effective_requirement(&self) -> EvidenceRequirement

Resolve the schema-v2 boolean into the typed admission requirement.

Trait Implementations

impl Clone for CompanionSpec

fn clone(&self) -> CompanionSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompanionSpec

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

Formats the value using the given formatter.

impl Default for CompanionSpec

fn default() -> CompanionSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CompanionSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CompanionSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.