Class OrPattern

A pattern that matches if any contained pattern matches.

Corresponds to the Rust OrPattern struct in or_pattern.rs

Implements

Matcher

Index

Methods

new patterns pathsWithCaptures paths matches compile isComplex toString equals hashCode

Methods

`Static`new

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

patterns

patterns(): Pattern[]
Gets the patterns.

Returns Pattern[]
- Defined in envelope-pattern/src/pattern/meta/or-pattern.ts:50

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/or-pattern.ts:54

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/or-pattern.ts:65

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/or-pattern.ts:69

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/or-pattern.ts:73

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

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/meta/or-pattern.ts:123

equals

equals(other: OrPattern): boolean
Equality comparison.
Parameters
- other: OrPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/meta/or-pattern.ts:130

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/meta/or-pattern.ts:145