Class TaggedPattern

Pattern for matching tagged CBOR values.

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

Corresponds to the Rust TaggedPattern struct in tagged_pattern.rs

Implements

Matcher

Index

Accessors

Methods

any withTag withName withRegex fromDcborPattern pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

inner

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

Returns TaggedPattern
- Defined in envelope-pattern/src/pattern/leaf/tagged-pattern.ts:88

Methods

`Static`any

any(): TaggedPattern
Creates a new TaggedPattern that matches any tagged value.

Returns TaggedPattern
- Defined in envelope-pattern/src/pattern/leaf/tagged-pattern.ts:53

`Static`withTag

withTag(tag: Tag, pattern: Pattern): TaggedPattern
Creates a new TaggedPattern with a specific tag and content pattern.
Parameters
- tag: Tag
- pattern: Pattern
Returns TaggedPattern
- Defined in envelope-pattern/src/pattern/leaf/tagged-pattern.ts:60

`Static`withName

withName(name: string, pattern: Pattern): TaggedPattern
Creates a new TaggedPattern with a specific tag name and content pattern.
Parameters
- name: string
- pattern: Pattern
Returns TaggedPattern
- Defined in envelope-pattern/src/pattern/leaf/tagged-pattern.ts:67

`Static`withRegex

withRegex(regex: RegExp, pattern: Pattern): TaggedPattern
Creates a new TaggedPattern with a tag name matching regex and content pattern.
Parameters
- regex: RegExp
- pattern: Pattern
Returns TaggedPattern
- Defined in envelope-pattern/src/pattern/leaf/tagged-pattern.ts:74

`Static`fromDcborPattern

fromDcborPattern(dcborPattern: TaggedPattern): TaggedPattern
Creates a new TaggedPattern from a dcbor-pattern TaggedPattern.
Parameters
- dcborPattern: TaggedPattern
Returns TaggedPattern
- Defined in envelope-pattern/src/pattern/leaf/tagged-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/tagged-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/tagged-pattern.ts:138

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/tagged-pattern.ts:142

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/tagged-pattern.ts:146

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/tagged-pattern.ts:153

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/leaf/tagged-pattern.ts:157

equals

equals(other: TaggedPattern): boolean
Equality comparison.
Parameters
- other: TaggedPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/leaf/tagged-pattern.ts:164

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/leaf/tagged-pattern.ts:203