Class BoolPattern

Pattern for matching boolean values.

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

Corresponds to the Rust BoolPattern struct in bool_pattern.rs

Implements

Matcher

Index

Accessors

Methods

any value fromDcborPattern pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

inner

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

Returns BoolPattern
- Defined in envelope-pattern/src/pattern/leaf/bool-pattern.ts:69

Methods

`Static`any

any(): BoolPattern
Creates a new BoolPattern that matches any boolean value.

Returns BoolPattern
- Defined in envelope-pattern/src/pattern/leaf/bool-pattern.ts:48

`Static`value

value(value: boolean): BoolPattern
Creates a new BoolPattern that matches the specific boolean value.
Parameters
- value: boolean
Returns BoolPattern
- Defined in envelope-pattern/src/pattern/leaf/bool-pattern.ts:55

`Static`fromDcborPattern

fromDcborPattern(dcborPattern: BoolPattern): BoolPattern
Creates a new BoolPattern from a dcbor-pattern BoolPattern.
Parameters
- dcborPattern: BoolPattern
Returns BoolPattern
- Defined in envelope-pattern/src/pattern/leaf/bool-pattern.ts:62

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/bool-pattern.ts:73

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

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/bool-pattern.ts:96

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/bool-pattern.ts:100

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/bool-pattern.ts:107

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/leaf/bool-pattern.ts:111

equals

equals(other: BoolPattern): boolean
Equality comparison.
Parameters
- other: BoolPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/leaf/bool-pattern.ts:118

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/leaf/bool-pattern.ts:132