Class ByteStringPattern

Pattern for matching byte string values.

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

Corresponds to the Rust ByteStringPattern struct in byte_string_pattern.rs

Implements

Matcher

Index

Accessors

Methods

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

Accessors

inner

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

Returns ByteStringPattern
- Defined in envelope-pattern/src/pattern/leaf/byte-string-pattern.ts:79

Methods

`Static`any

any(): ByteStringPattern
Creates a new ByteStringPattern that matches any byte string.

Returns ByteStringPattern
- Defined in envelope-pattern/src/pattern/leaf/byte-string-pattern.ts:51

`Static`value

value(value: Uint8Array): ByteStringPattern
Creates a new ByteStringPattern that matches the specific byte string.
Parameters
- value: Uint8Array
Returns ByteStringPattern
- Defined in envelope-pattern/src/pattern/leaf/byte-string-pattern.ts:58

`Static`regex

regex(pattern: RegExp): ByteStringPattern
Creates a new ByteStringPattern that matches byte strings matching the binary regex.
Parameters
- pattern: RegExp
Returns ByteStringPattern
- Defined in envelope-pattern/src/pattern/leaf/byte-string-pattern.ts:65

`Static`fromDcborPattern

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

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/byte-string-pattern.ts:104

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/byte-string-pattern.ts:108

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/byte-string-pattern.ts:115

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/leaf/byte-string-pattern.ts:119

equals

equals(other: ByteStringPattern): boolean
Equality comparison.
Parameters
- other: ByteStringPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/leaf/byte-string-pattern.ts:126

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/leaf/byte-string-pattern.ts:153