Class TraversePattern

A pattern that matches a traversal order of patterns.

Corresponds to the Rust TraversePattern struct in traverse_pattern.rs

Implements

Matcher

Index

Methods

new patterns pathsWithCaptures paths matches compile isComplex toString equals hashCode

Methods

`Static`new

new(patterns: Pattern[]): TraversePattern
Creates a new TraversePattern with the given patterns.
Parameters
- patterns: Pattern[]
Returns TraversePattern
- Defined in envelope-pattern/src/pattern/meta/traverse-pattern.ts:60

patterns

patterns(): Pattern[]
Gets all patterns in this traversal.

Returns Pattern[]
- Defined in envelope-pattern/src/pattern/meta/traverse-pattern.ts:74

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/traverse-pattern.ts:82

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/traverse-pattern.ts:109

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/traverse-pattern.ts:113

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/traverse-pattern.ts:117

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/traverse-pattern.ts:134

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/meta/traverse-pattern.ts:141

equals

equals(other: TraversePattern): boolean
Equality comparison.
Parameters
- other: TraversePattern
Returns boolean
- Defined in envelope-pattern/src/pattern/meta/traverse-pattern.ts:150

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/meta/traverse-pattern.ts:167