Class KnownValuePattern

Pattern for matching known values.

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

Corresponds to the Rust KnownValuePattern struct in known_value_pattern.rs

Implements

Matcher

Index

Accessors

Methods

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

Accessors

inner

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

Returns KnownValuePattern
- Defined in envelope-pattern/src/pattern/leaf/known-value-pattern.ts:88

Methods

`Static`any

any(): KnownValuePattern
Creates a new KnownValuePattern that matches any known value.

Returns KnownValuePattern
- Defined in envelope-pattern/src/pattern/leaf/known-value-pattern.ts:53

`Static`value

value(value: KnownValue): KnownValuePattern
Creates a new KnownValuePattern that matches the specific known value.
Parameters
- value: KnownValue
Returns KnownValuePattern
- Defined in envelope-pattern/src/pattern/leaf/known-value-pattern.ts:60

`Static`named

named(name: string): KnownValuePattern
Creates a new KnownValuePattern that matches known values by name.
Parameters
- name: string
Returns KnownValuePattern
- Defined in envelope-pattern/src/pattern/leaf/known-value-pattern.ts:67

`Static`regex

regex(regex: RegExp): KnownValuePattern
Creates a new KnownValuePattern that matches known values by regex on their name.
Parameters
- regex: RegExp
Returns KnownValuePattern
- Defined in envelope-pattern/src/pattern/leaf/known-value-pattern.ts:74

`Static`fromDcborPattern

fromDcborPattern(dcborPattern: KnownValuePattern): KnownValuePattern
Creates a new KnownValuePattern from a dcbor-pattern KnownValuePattern.
Parameters
- dcborPattern: KnownValuePattern
Returns KnownValuePattern
- Defined in envelope-pattern/src/pattern/leaf/known-value-pattern.ts:81

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/known-value-pattern.ts:92

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/known-value-pattern.ts:116

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

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/known-value-pattern.ts:124

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/known-value-pattern.ts:131

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/leaf/known-value-pattern.ts:135

equals

equals(other: KnownValuePattern): boolean
Equality comparison.
Parameters
- other: KnownValuePattern
Returns boolean
- Defined in envelope-pattern/src/pattern/leaf/known-value-pattern.ts:142

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/leaf/known-value-pattern.ts:168