Class DigestPattern

Pattern for matching envelopes by their digest.

Corresponds to the Rust DigestPattern enum in digest_pattern.rs

Implements

Matcher

Index

Accessors

Methods

any digest prefix binaryRegex pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

patternType

get patternType(): DigestPatternType
Gets the pattern type.

Returns DigestPatternType
- Defined in envelope-pattern/src/pattern/structure/digest-pattern.ts:89

Methods

`Static`any

any(): DigestPattern
Creates a new DigestPattern that matches any digest.

Returns DigestPattern
- Defined in envelope-pattern/src/pattern/structure/digest-pattern.ts:61

`Static`digest

digest(digest: Digest): DigestPattern
Creates a new DigestPattern that matches the exact digest.
Parameters
- digest: Digest
Returns DigestPattern
- Defined in envelope-pattern/src/pattern/structure/digest-pattern.ts:68

`Static`prefix

prefix(prefix: Uint8Array): DigestPattern
Creates a new DigestPattern that matches the prefix of a digest.
Parameters
- prefix: Uint8Array
Returns DigestPattern
- Defined in envelope-pattern/src/pattern/structure/digest-pattern.ts:75

`Static`binaryRegex

binaryRegex(regex: RegExp): DigestPattern
Creates a new DigestPattern that matches the binary regex for a digest.
Parameters
- regex: RegExp
Returns DigestPattern
- Defined in envelope-pattern/src/pattern/structure/digest-pattern.ts:82

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/structure/digest-pattern.ts:93

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/structure/digest-pattern.ts:130

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/structure/digest-pattern.ts:134

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/structure/digest-pattern.ts:138

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/structure/digest-pattern.ts:145

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/structure/digest-pattern.ts:149

equals

equals(other: DigestPattern): boolean
Equality comparison.
Parameters
- other: DigestPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/structure/digest-pattern.ts:165

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/structure/digest-pattern.ts:196