Class WrappedPattern

Represents patterns for matching wrapped envelopes.

Corresponds to the Rust WrappedPattern enum in wrapped_pattern.rs

Implements

Matcher

Index

Accessors

Methods

new unwrapMatching unwrap innerPattern pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

patternType

get patternType(): WrappedPatternType
Gets the pattern type.

Returns WrappedPatternType
- Defined in envelope-pattern/src/pattern/structure/wrapped-pattern.ts:90

Methods

`Static`new

new(): WrappedPattern
Creates a new WrappedPattern that matches any wrapped envelope without descending.

Returns WrappedPattern
- Defined in envelope-pattern/src/pattern/structure/wrapped-pattern.ts:65

`Static`unwrapMatching

unwrapMatching(pattern: Pattern): WrappedPattern
Creates a new WrappedPattern that matches a wrapped envelope and also matches on its unwrapped content.
Parameters
- pattern: Pattern
Returns WrappedPattern
- Defined in envelope-pattern/src/pattern/structure/wrapped-pattern.ts:73

`Static`unwrap

unwrap(): WrappedPattern
Creates a new WrappedPattern that matches any wrapped envelope and descends into it. Note: This requires Pattern.any() to be available, so it's set up during registration.

Returns WrappedPattern
- Defined in envelope-pattern/src/pattern/structure/wrapped-pattern.ts:81

innerPattern

innerPattern(): Pattern | undefined
Gets the inner pattern if this is an Unwrap type, undefined otherwise.

Returns Pattern | undefined
- Defined in envelope-pattern/src/pattern/structure/wrapped-pattern.ts:97

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/structure/wrapped-pattern.ts:101

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

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/structure/wrapped-pattern.ts:138

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/structure/wrapped-pattern.ts:142

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/structure/wrapped-pattern.ts:174

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/structure/wrapped-pattern.ts:178

equals

equals(other: WrappedPattern): boolean
Equality comparison.
Parameters
- other: WrappedPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/structure/wrapped-pattern.ts:198

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/structure/wrapped-pattern.ts:213