Class TextPattern

Pattern for matching text values.

This is a wrapper around dcbor_pattern::TextPattern that provides envelope-specific integration.

Corresponds to the Rust TextPattern struct in text_pattern.rs

Implements

Matcher

Index

Accessors

Methods

any value regex fromDcborPattern pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

inner

get inner(): TextPattern
Gets the underlying dcbor-pattern TextPattern.

Returns TextPattern
- Defined in envelope-pattern/src/pattern/leaf/text-pattern.ts:77

Methods

`Static`any

any(): TextPattern
Creates a new TextPattern that matches any text.

Returns TextPattern
- Defined in envelope-pattern/src/pattern/leaf/text-pattern.ts:49

`Static`value

value(value: string): TextPattern
Creates a new TextPattern that matches the specific text.
Parameters
- value: string
Returns TextPattern
- Defined in envelope-pattern/src/pattern/leaf/text-pattern.ts:56

`Static`regex

regex(pattern: RegExp): TextPattern
Creates a new TextPattern that matches text matching the regex.
Parameters
- pattern: RegExp
Returns TextPattern
- Defined in envelope-pattern/src/pattern/leaf/text-pattern.ts:63

`Static`fromDcborPattern

fromDcborPattern(dcborPattern: TextPattern): TextPattern
Creates a new TextPattern from a dcbor-pattern TextPattern.
Parameters
- dcborPattern: TextPattern
Returns TextPattern
- Defined in envelope-pattern/src/pattern/leaf/text-pattern.ts:70

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/text-pattern.ts:81

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/text-pattern.ts:98

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/text-pattern.ts:102

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/text-pattern.ts:106

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

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/leaf/text-pattern.ts:117

equals

equals(other: TextPattern): boolean
Equality comparison.
Parameters
- other: TextPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/leaf/text-pattern.ts:124

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/leaf/text-pattern.ts:146