Class CapturePattern

A pattern that captures a match with a name.

Corresponds to the Rust CapturePattern struct in capture_pattern.rs

Implements

Matcher

Index

Methods

new name pattern pathsWithCaptures paths matches compile isComplex toString equals hashCode

Methods

`Static`new

new(name: string, pattern: Pattern): CapturePattern
Creates a new CapturePattern with the given name and pattern.
Parameters
- name: string
- pattern: Pattern
Returns CapturePattern
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:40

name

name(): string
Gets the name of the capture.

Returns string
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:47

pattern

pattern(): Pattern
Gets the inner pattern.

Returns Pattern
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:54

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[]>]
Implementation of Matcher.pathsWithCaptures
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:58

paths

paths(haystack: Envelope): Path[]
Return only the matching paths, discarding any captures.
Parameters
- haystack: Envelope
Returns Path[]
Implementation of Matcher.paths
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:69

matches

matches(haystack: Envelope): boolean
Returns true if the pattern matches the haystack.
Parameters
- haystack: Envelope
Returns boolean
Implementation of Matcher.matches
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:73

compile

compile(code: Instr[], literals: Pattern[], captures: string[]): void
Compile this pattern to bytecode.
Parameters
- code: Instr[]
- literals: Pattern[]
- captures: string[]
Returns void
Implementation of Matcher.compile
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:77

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
Implementation of Matcher.isComplex
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:85

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:89

equals

equals(other: CapturePattern): boolean
Equality comparison.
Parameters
- other: CapturePattern
Returns boolean
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:96

hashCode

hashCode(): number
Hash code for use in Maps/Sets.

Returns number
- Defined in envelope-pattern/src/pattern/meta/capture-pattern.ts:103