Class SubjectPattern

Pattern for matching subjects in envelopes.

Corresponds to the Rust SubjectPattern enum in subject_pattern.rs

Implements

Matcher

Index

Accessors

Methods

any pattern innerPattern pathsWithCaptures paths matches compile isComplex toString equals hashCode

Accessors

patternType

get patternType(): SubjectPatternType
Gets the pattern type.

Returns SubjectPatternType
- Defined in envelope-pattern/src/pattern/structure/subject-pattern.ts:60

Methods

`Static`any

any(): SubjectPattern
Creates a new SubjectPattern that matches any subject.

Returns SubjectPattern
- Defined in envelope-pattern/src/pattern/structure/subject-pattern.ts:46

`Static`pattern

pattern(pattern: Pattern): SubjectPattern
Creates a new SubjectPattern that matches subjects matching the given pattern.
Parameters
- pattern: Pattern
Returns SubjectPattern
- Defined in envelope-pattern/src/pattern/structure/subject-pattern.ts:53

innerPattern

innerPattern(): Pattern | undefined
Gets the inner pattern if this is a Pattern type, undefined otherwise.

Returns Pattern | undefined
- Defined in envelope-pattern/src/pattern/structure/subject-pattern.ts:67

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/subject-pattern.ts:71

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/subject-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/structure/subject-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/structure/subject-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/structure/subject-pattern.ts:116

toString

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

Returns string
- Defined in envelope-pattern/src/pattern/structure/subject-pattern.ts:120

equals

equals(other: SubjectPattern): boolean
Equality comparison.
Parameters
- other: SubjectPattern
Returns boolean
- Defined in envelope-pattern/src/pattern/structure/subject-pattern.ts:132

hashCode

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

Returns number
- Defined in envelope-pattern/src/pattern/structure/subject-pattern.ts:148