Class NullPattern

Pattern for matching null values.

This is a wrapper around dcbor_pattern::NullPattern that provides envelope-specific functionality.

Corresponds to the Rust NullPattern struct in null_pattern.rs

Implements

Matcher

Index

Accessors

Methods

new pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

inner

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

Returns NullPattern
- Defined in envelope-pattern/src/pattern/leaf/null-pattern.ts:55

Methods

`Static`new

new(): NullPattern
Creates a new NullPattern (returns singleton).

Returns NullPattern
- Defined in envelope-pattern/src/pattern/leaf/null-pattern.ts:48

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/null-pattern.ts:59

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/null-pattern.ts:74

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/null-pattern.ts:78

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/null-pattern.ts:82

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/null-pattern.ts:89

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/leaf/null-pattern.ts:93

equals

equals(other: NullPattern): boolean
Equality comparison.
Parameters
- other: NullPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/leaf/null-pattern.ts:100

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/leaf/null-pattern.ts:107