ecluse
Safe HaskellNone
LanguageGHC2021

Ecluse.Config.Rule

Description

Resolve named rule patches against a base policy, accumulating malformed entries. Mount patches keep unspecified parameters and phases, or remove an entry with enabled: false.

Synopsis

Policies

newtype RulePolicy Source #

A resolved rule set, keyed by the rule name an operator patches it under.

Constructors

RulePolicy 

Fields

Instances

Instances details
Show RulePolicy Source # 
Instance details

Defined in Ecluse.Config.Rule

Eq RulePolicy Source # 
Instance details

Defined in Ecluse.Config.Rule

emptyPolicy :: RulePolicy Source #

The policy a load starts from before the shipped defaults are applied.

resolvePolicy :: RulePolicy -> RulePatch -> Either [PolicyError] RulePolicy Source #

Apply a patch to a base policy. Every entry resolves before any applies, so one load reports every refusal.

Declared patches

newtype RulePatch Source #

A declared rules object: one RuleEntry per rule name it names.

Constructors

RulePatch (Map Text RuleEntry) 

Instances

Instances details
Show RulePatch Source # 
Instance details

Defined in Ecluse.Config.Rule

Eq RulePatch Source # 
Instance details

Defined in Ecluse.Config.Rule

data RuleEntry Source #

One rule's declared keys, every one optional. refuseStrayParameters refuses those its type does not read.

Instances

Instances details
Show RuleEntry Source # 
Instance details

Defined in Ecluse.Config.Rule

Eq RuleEntry Source # 
Instance details

Defined in Ecluse.Config.Rule

knownRuleTypes :: [Text] Source #

The rule type names the diagnostics recognise. Any other name is an UnknownRuleType.

Refusals

data PolicyError Source #

Why one declared rule was refused. A load reports every one it accumulated.

Instances

Instances details
Show PolicyError Source # 
Instance details

Defined in Ecluse.Config.Rule

Eq PolicyError Source # 
Instance details

Defined in Ecluse.Config.Rule

renderPolicyError :: PolicyError -> Text Source #

One refusal as the boot reports it, naming the rule it was declared under.