| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
OptEnvConf.Capability
Contents
Synopsis
- newtype Capabilities = Capabilities {}
- newtype Capability = Capability {
- unCapability :: Text
- allCapabilities :: Capabilities
- enableCapability :: Capability -> Capabilities -> Capabilities
- disableCapability :: Capability -> Capabilities -> Capabilities
- missingCapabilities :: Capabilities -> Set Capability -> Maybe (NonEmpty Capability)
- readSecretCapability :: String
Documentation
newtype Capabilities Source #
Constructors
| Capabilities | |
Fields | |
Instances
newtype Capability Source #
Constructors
| Capability | |
Fields
| |
Instances
| IsString Capability Source # | |||||
Defined in OptEnvConf.Capability Methods fromString :: String -> Capability # | |||||
| Generic Capability Source # | |||||
Defined in OptEnvConf.Capability Associated Types
| |||||
| Show Capability Source # | |||||
Defined in OptEnvConf.Capability Methods showsPrec :: Int -> Capability -> ShowS # show :: Capability -> String # showList :: [Capability] -> ShowS # | |||||
| Eq Capability Source # | |||||
Defined in OptEnvConf.Capability | |||||
| Ord Capability Source # | |||||
Defined in OptEnvConf.Capability Methods compare :: Capability -> Capability -> Ordering # (<) :: Capability -> Capability -> Bool # (<=) :: Capability -> Capability -> Bool # (>) :: Capability -> Capability -> Bool # (>=) :: Capability -> Capability -> Bool # max :: Capability -> Capability -> Capability # min :: Capability -> Capability -> Capability # | |||||
| Validity Capability Source # | |||||
Defined in OptEnvConf.Capability Methods validate :: Capability -> Validation # | |||||
| type Rep Capability Source # | |||||
Defined in OptEnvConf.Capability type Rep Capability = D1 ('MetaData "Capability" "OptEnvConf.Capability" "opt-env-conf-0.13.0.0-A5s15TTGNbh4kDLCrIzHaC" 'True) (C1 ('MetaCons "Capability" 'PrefixI 'True) (S1 ('MetaSel ('Just "unCapability") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) | |||||
missingCapabilities :: Capabilities -> Set Capability -> Maybe (NonEmpty Capability) Source #
Predefined capabilities
readSecretCapability :: String Source #
The annotation for any setting reading secrets.
We add these so that we can disable them in settings checks, to avoid failing settings checks when secrets are read at runtime instead of build-time.