Struct FieldRule 

pub struct FieldRule {
    pub selector: Selector,
    pub mode: ExtractMode,
    pub keys: Vec<String>,
    pub exclude_keys: Vec<String>,
    pub prefix: String,
    pub prefix_keys: HashMap<String, String>,
    pub max_depth: usize,
}

One text source within a document.

Fields

selector: Selector

What this rule selects. See Selector.

mode: ExtractMode

How the selected nodes are turned into text. See ExtractMode.

keys: Vec<String>

Object keys whose string values are indexed. Empty means every key — the pre-keys behaviour.

Strings not under any object key are always indexed: elements of the selected array, and the selected node when it is itself a string. Nothing names them, so an allowlist has nothing to match — without this, setting keys would lose notillo’s plainest text (a bare CompactInlineContent string) and every string-selecting rule such as pr.caption.

This is not the mirror of exclude_keys: that prunes a subtree, this gates a leaf. Containers are always descended, so a document with dynamic keys (calcillo’s rows.<rowId>.<colId>) still reaches its text. It cannot separate the members of a positional tuple like ["Hi", "b"] — both carry the same enclosing key — unless the part rule deletes one first; see PartRule::prune. Only meaningful for ExtractMode::Text.

exclude_keys: Vec<String>

Object keys whose values are skipped entirely (link targets, colors…). Only meaningful for ExtractMode::Text.

prefix: String

Constant prefix on every token this rule emits, e.g. "#" on a rule selecting tag values. Unlike prefix_keys it survives ExtractMode::String and a JSONPath selector that lands on the value itself, where there is no key left to match.

prefix_keys: HashMap<String, String>

Object keys whose string values get a prefix — e.g. {"tg": "#"} turns a tag node’s text into a #tag token.

max_depth: usize

Implementations

impl FieldRule

pub fn dotted(field: &str) -> Self

A plain dotted-path, whole-document-walk rule — the shape a bare string entry in a manifest produces.

Trait Implementations

impl Clone for FieldRule

fn clone(&self) -> FieldRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldRule

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

Formats the value using the given formatter.