Class SearchPattern

A pattern that searches the entire envelope tree for matches.

Corresponds to the Rust SearchPattern struct in search_pattern.rs

Implements

Matcher

Index

Methods

new pattern pathsWithCaptures paths matches compile isComplex toString equals hashCode

Methods

`Static`new

new(pattern: Pattern): SearchPattern
Creates a new SearchPattern with the given pattern.
Parameters
- pattern: Pattern
Returns SearchPattern
- Defined in envelope-pattern/src/pattern/meta/search-pattern.ts:38

pattern

pattern(): Pattern
Gets the inner pattern.

Returns Pattern
- Defined in envelope-pattern/src/pattern/meta/search-pattern.ts:45

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/search-pattern.ts:49

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/search-pattern.ts:139

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/search-pattern.ts:143

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/search-pattern.ts:147

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/search-pattern.ts:168

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/meta/search-pattern.ts:172

equals

equals(other: SearchPattern): boolean
Equality comparison.
Parameters
- other: SearchPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/meta/search-pattern.ts:179

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/meta/search-pattern.ts:186