Class GroupPattern

A pattern that matches with repetition.

Corresponds to the Rust GroupPattern struct in repeat_pattern.rs

Implements

Matcher

Index

Methods

repeat new pattern quantifier pathsWithCaptures paths matches compile isComplex toString equals hashCode

Methods

`Static`repeat

repeat(pattern: Pattern, quantifier: Quantifier): GroupPattern
Creates a new GroupPattern with the specified sub-pattern and quantifier.
Parameters
- pattern: Pattern
- quantifier: Quantifier
Returns GroupPattern
- Defined in envelope-pattern/src/pattern/meta/group-pattern.ts:41

`Static`new

new(pattern: Pattern): GroupPattern
Creates a new GroupPattern with a quantifier that matches exactly once.
Parameters
- pattern: Pattern
Returns GroupPattern
- Defined in envelope-pattern/src/pattern/meta/group-pattern.ts:48

pattern

pattern(): Pattern
Gets the sub-pattern of this group pattern.

Returns Pattern
- Defined in envelope-pattern/src/pattern/meta/group-pattern.ts:55

quantifier

quantifier(): Quantifier
Gets the quantifier of this group pattern.

Returns Quantifier
- Defined in envelope-pattern/src/pattern/meta/group-pattern.ts:62

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/group-pattern.ts:66

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/group-pattern.ts:76

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/group-pattern.ts:80

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/group-pattern.ts:84

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/group-pattern.ts:90

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/meta/group-pattern.ts:94

equals

equals(other: GroupPattern): boolean
Equality comparison.
Parameters
- other: GroupPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/meta/group-pattern.ts:102

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/meta/group-pattern.ts:109