Enum CaptureMode 

pub enum CaptureMode {
    NonCapture,
    Count,
    Span,
    NamedCapture,
    RepeatedCapture,
    GroupExtraction,
}

Capture output mode a consumer requests for a regex scan, wiring docs/optimization/REGEX_CAPTURE_MODE_CONTRACTS.toml to code.

A consumer routes on this instead of parsing the TOML: accelerator_eligible says whether the GPU DFA/AC path can serve the request directly, and verifier_required says whether a scalar (CPU-semantics) verifier must own the output. The three whole-match modes run entirely on the accelerator; the three group-extraction modes need the verifier (the byte-DFA has no capture stack). Keeping this a typed enum with one contract_row owner means the routing decision has one home and cannot silently disagree with the contract.

Variants

NonCapture

Whole match only, no spans (whole_match_only). Accelerator path.

Count

Match count per pattern (match_count_per_pattern). Accelerator path.

Span

Whole-match (start, end) span (whole_match_span). Accelerator path.

NamedCapture

Named group span records (named_group_span_records). Verifier-bound; unmatched group → null.

RepeatedCapture

Ordered list of spans for a repeated group (ordered_group_span_list). Verifier-bound; an empty repeat yields an empty list.

GroupExtraction

Row × group value table (row_group_value_table). Verifier-bound; unmatched group → null.

Implementations

impl CaptureMode

pub const ALL: [CaptureMode; 6]

Every mode, in contract order. One owner for iteration + coherence checks.

pub const fn contract_row(self) -> CaptureModeContract

The contract row for this mode, the single code-side source of truth for its mode_id, output_shape, routing bits, and null policy.

pub const fn accelerator_eligible(self) -> bool

Whether the GPU accelerator path can serve this mode directly (no verifier). The three whole-match modes are eligible; group-extraction is not.

pub const fn verifier_required(self) -> bool

Whether a scalar (CPU-semantics) verifier must own this mode’s output. The exact complement of accelerator_eligible under this contract, but named separately because the two are independent contract fields, a future mode could be neither (unsupported) rather than exactly one.

pub fn from_mode_id(mode_id: &str) -> Option<CaptureMode>

Look up a mode by its stable mode_id string (the reverse of contract_row().mode_id), for consumers that receive the mode as config text. Returns None for an unknown id.

Trait Implementations

impl Clone for CaptureMode

fn clone(&self) -> CaptureMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CaptureMode

impl Debug for CaptureMode

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

Formats the value using the given formatter.

impl Eq for CaptureMode

impl Hash for CaptureMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CaptureMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CaptureMode