Class ObscuredPattern

Pattern for matching obscured elements.

Corresponds to the Rust ObscuredPattern enum in obscured_pattern.rs

Implements

Matcher

Index

Accessors

Methods

any elided encrypted compressed pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

patternType

get patternType(): ObscuredPatternType
Gets the pattern type.

Returns ObscuredPatternType
- Defined in envelope-pattern/src/pattern/structure/obscured-pattern.ts:79

Methods

`Static`any

any(): ObscuredPattern
Creates a new ObscuredPattern that matches any obscured element.

Returns ObscuredPattern
- Defined in envelope-pattern/src/pattern/structure/obscured-pattern.ts:51

`Static`elided

elided(): ObscuredPattern
Creates a new ObscuredPattern that matches any elided element.

Returns ObscuredPattern
- Defined in envelope-pattern/src/pattern/structure/obscured-pattern.ts:58

`Static`encrypted

encrypted(): ObscuredPattern
Creates a new ObscuredPattern that matches any encrypted element.

Returns ObscuredPattern
- Defined in envelope-pattern/src/pattern/structure/obscured-pattern.ts:65

`Static`compressed

compressed(): ObscuredPattern
Creates a new ObscuredPattern that matches any compressed element.

Returns ObscuredPattern
- Defined in envelope-pattern/src/pattern/structure/obscured-pattern.ts:72

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/obscured-pattern.ts:83

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/obscured-pattern.ts:105

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/obscured-pattern.ts:109

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/obscured-pattern.ts:113

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/obscured-pattern.ts:120

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/structure/obscured-pattern.ts:124

equals

equals(other: ObscuredPattern): boolean
Equality comparison.
Parameters
- other: ObscuredPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/structure/obscured-pattern.ts:140

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/structure/obscured-pattern.ts:147