Class MapPattern

Pattern for matching map values in envelope leaf nodes.

Corresponds to the Rust MapPattern struct in map_pattern.rs

Implements

Matcher

Index

Accessors

Methods

any interval pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

pattern

get pattern(): MapPatternType
Gets the pattern type.

Returns MapPatternType
- Defined in envelope-pattern/src/pattern/leaf/map-pattern.ts:64

Methods

`Static`any

any(): MapPattern
Creates a new MapPattern that matches any map.

Returns MapPattern
- Defined in envelope-pattern/src/pattern/leaf/map-pattern.ts:49

`Static`interval

interval(min: number, max?: number): MapPattern
Creates a new MapPattern that matches maps within a size range.
Parameters
- min: number
- Optionalmax: number
Returns MapPattern
- Defined in envelope-pattern/src/pattern/leaf/map-pattern.ts:56

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/leaf/map-pattern.ts:68

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/leaf/map-pattern.ts:95

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/leaf/map-pattern.ts:99

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/leaf/map-pattern.ts:103

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/leaf/map-pattern.ts:110

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/leaf/map-pattern.ts:114

equals

equals(other: MapPattern): boolean
Equality comparison.
Parameters
- other: MapPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/leaf/map-pattern.ts:126

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/leaf/map-pattern.ts:143