Safe Haskell	None
Language	GHC2021

Ecluse.Config.Rule

Synopsis

newtype RulePolicy = RulePolicy {
- policyRules :: Map Text PrecededRule
}
emptyPolicy :: RulePolicy
data PolicyError
- = MissingRuleType Text
- | UnknownRuleType Text Text
- | MalformedRule Text Text
- | SuppressUnknownRule Text
renderPolicyError :: PolicyError -> Text
knownRuleTypes :: [Text]
resolvePolicy :: RulePolicy -> RulePatch -> Either [PolicyError] RulePolicy
newtype RulePatch = RulePatch (Map Text RuleEntry)
data RuleEntry = RuleEntry {
- entryType :: Maybe Text
- entryPrecedence :: Maybe Int
- entryEnabled :: Maybe Bool
- entryAgeSeconds :: Maybe Integer
- entryScope :: Maybe Text
- entryIdentity :: Maybe Text
- entryMinSeverity :: Maybe Double
- entryOnUnavailable :: Maybe Text
}

Documentation

newtype RulePolicy Source #

Constructors

RulePolicy
Fields policyRules :: Map Text PrecededRule

Instances

Instances details

Show RulePolicy Source #
Instance details Defined in Ecluse.Config.Rule Methods showsPrec :: Int -> RulePolicy -> ShowS # show :: RulePolicy -> String # showList :: [RulePolicy] -> ShowS #
Eq RulePolicy Source #
Instance details Defined in Ecluse.Config.Rule Methods (==) :: RulePolicy -> RulePolicy -> Bool # (/=) :: RulePolicy -> RulePolicy -> Bool #

emptyPolicy :: RulePolicy Source #

data PolicyError Source #

Constructors

MissingRuleType Text
UnknownRuleType Text Text
MalformedRule Text Text
SuppressUnknownRule Text

Instances

Instances details

Show PolicyError Source #
Instance details Defined in Ecluse.Config.Rule Methods showsPrec :: Int -> PolicyError -> ShowS # show :: PolicyError -> String # showList :: [PolicyError] -> ShowS #
Eq PolicyError Source #
Instance details Defined in Ecluse.Config.Rule Methods (==) :: PolicyError -> PolicyError -> Bool # (/=) :: PolicyError -> PolicyError -> Bool #

renderPolicyError :: PolicyError -> Text Source #

knownRuleTypes :: [Text] Source #

The rule type names the diagnostics recognise: the vocabulary checkRestatedType treats as a real-but-mismatched type (a MalformedRule) rather than an unknown one (an UnknownRuleType). Exported so a test can pin it against drift from the Rule constructors, their buildRule branches, and ruleName.

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

newtype RulePatch Source #

Constructors

RulePatch (Map Text RuleEntry)

Instances

Instances details

FromJSON RulePatch Source #
Instance details Defined in Ecluse.Config.Aeson Methods parseJSON :: Value -> Parser RulePatch Source # parseJSONList :: Value -> Parser [RulePatch] Source # omittedField :: Maybe RulePatch Source #
Show RulePatch Source #
Instance details Defined in Ecluse.Config.Rule Methods showsPrec :: Int -> RulePatch -> ShowS # show :: RulePatch -> String # showList :: [RulePatch] -> ShowS #
Eq RulePatch Source #
Instance details Defined in Ecluse.Config.Rule Methods (==) :: RulePatch -> RulePatch -> Bool # (/=) :: RulePatch -> RulePatch -> Bool #

data RuleEntry Source #

Constructors

RuleEntry
Fields entryType :: Maybe Text entryPrecedence :: Maybe Int entryEnabled :: Maybe Bool entryAgeSeconds :: Maybe Integer entryScope :: Maybe Text entryIdentity :: Maybe Text entryMinSeverity :: Maybe Double entryOnUnavailable :: Maybe Text

Instances

Instances details

FromJSON RuleEntry Source #
Instance details Defined in Ecluse.Config.Aeson Methods parseJSON :: Value -> Parser RuleEntry Source # parseJSONList :: Value -> Parser [RuleEntry] Source # omittedField :: Maybe RuleEntry Source #
Show RuleEntry Source #
Instance details Defined in Ecluse.Config.Rule Methods showsPrec :: Int -> RuleEntry -> ShowS # show :: RuleEntry -> String # showList :: [RuleEntry] -> ShowS #
Eq RuleEntry Source #
Instance details Defined in Ecluse.Config.Rule Methods (==) :: RuleEntry -> RuleEntry -> Bool # (/=) :: RuleEntry -> RuleEntry -> Bool #