Struct StreamRule 

pub struct StreamRule {
    pub name: String,
    pub description: String,
    pub matcher: Regex,
    pub scope: RuleScope,
    pub mode: RuleMode,
    pub body: String,
}

A compiled stream rule loaded from ~/.roma/rules/<name>.md.

Fields

name: String

File stem of the rule file.

description: String

Frontmatter description.

matcher: Regex

Compiled frontmatter match pattern.

scope: RuleScope

Which stream content this rule matches against.

mode: RuleMode

What happens when this rule matches.

body: String

Markdown body — the text injected when the rule fires.

Implementations

impl StreamRule

pub fn new( name: impl Into<String>, description: impl Into<String>, pattern: &str, scope: RuleScope, mode: RuleMode, body: impl Into<String>, ) -> Result<Self, String>

Construct a rule from a pattern string, compiling the regex.

Trait Implementations

impl Debug for StreamRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.