Class CBORPattern

Pattern for matching CBOR values with support for exact values and advanced pattern matching.

Corresponds to the Rust CBORPattern enum in cbor_pattern.rs

Implements

Matcher

Index

Accessors

Methods

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

Accessors

pattern

get pattern(): CBORPatternType
Gets the pattern type.

Returns CBORPatternType
- Defined in envelope-pattern/src/pattern/leaf/cbor-pattern.ts:83

Methods

`Static`any

any(): CBORPattern
Creates a new CBORPattern that matches any CBOR value.

Returns CBORPattern
- Defined in envelope-pattern/src/pattern/leaf/cbor-pattern.ts:55

`Static`value

value(value: CborInput): CBORPattern
Creates a new CBORPattern that matches a specific CBOR value.
Parameters
- value: CborInput
Returns CBORPattern
- Defined in envelope-pattern/src/pattern/leaf/cbor-pattern.ts:62

`Static`pattern

pattern(dcborPattern: Pattern): CBORPattern
Creates a new CBORPattern that matches CBOR values using dcbor-pattern expressions.
Parameters
- dcborPattern: Pattern
Returns CBORPattern
- Defined in envelope-pattern/src/pattern/leaf/cbor-pattern.ts:69

`Static`fromDcborPattern

fromDcborPattern(dcborPattern: Pattern): CBORPattern
Creates a new CBORPattern from a dcbor-pattern Pattern.
Parameters
- dcborPattern: Pattern
Returns CBORPattern
- Defined in envelope-pattern/src/pattern/leaf/cbor-pattern.ts:76

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/cbor-pattern.ts:158

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/cbor-pattern.ts:260

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/cbor-pattern.ts:264

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/cbor-pattern.ts:268

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/cbor-pattern.ts:286

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/leaf/cbor-pattern.ts:290

equals

equals(other: CBORPattern): boolean
Equality comparison.
Parameters
- other: CBORPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/leaf/cbor-pattern.ts:304

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/leaf/cbor-pattern.ts:331