Interface Matcher

Matcher interface for pattern matching against envelopes.

Corresponds to the Rust Matcher trait in matcher.rs

interface Matcher {
    pathsWithCaptures(haystack: Envelope): [Path[], Map<string, Path[]>];
    paths(haystack: Envelope): Path[];
    matches(haystack: Envelope): boolean;
    compile(code: Instr[], literals: Pattern[], captures: string[]): void;
    isComplex(): boolean;
}

Index

Methods

pathsWithCaptures paths matches compile isComplex

Methods

pathsWithCaptures

pathsWithCaptures(haystack: Envelope): [Path[], Map<string, Path[]>]
Return all matching paths along with any named captures.
Parameters
- haystack: Envelope
Returns [Path[], Map<string, Path[]>]
- Defined in envelope-pattern/src/pattern/matcher.ts:23

paths

paths(haystack: Envelope): Path[]
Return only the matching paths, discarding any captures.
Parameters
- haystack: Envelope
Returns Path[]
- Defined in envelope-pattern/src/pattern/matcher.ts:28

matches

matches(haystack: Envelope): boolean
Returns true if the pattern matches the haystack.
Parameters
- haystack: Envelope
Returns boolean
- Defined in envelope-pattern/src/pattern/matcher.ts:33

compile

compile(code: Instr[], literals: Pattern[], captures: string[]): void
Compile this pattern to bytecode.
Parameters
- code: Instr[]
- literals: Pattern[]
- captures: string[]
Returns void
- Defined in envelope-pattern/src/pattern/matcher.ts:38

isComplex

isComplex(): boolean
Returns true if the Display of the matcher is complex, i.e. contains nested patterns or other complex structures that require its text rendering to be surrounded by grouping parentheses.

Returns boolean
- Defined in envelope-pattern/src/pattern/matcher.ts:46