| Safe Haskell | None |
|---|---|
| Language | GHC2024 |
Napkin.Spec.Yaml.Interpret
Synopsis
- newtype YamlParseError = YamlParseError Text
- type LoadYamlConstraint backend = (SpecBackend backend, Default (DbBackendOptions backend), Show (DbBackendOptions backend), FromJSON (DbBackendOptions backend), Eq (BackendTableMeta backend), Show (BackendTableMeta backend), RunBackendEffect backend, RunBackendConn backend, DumpBackendRequirements backend, HasBackendQueryStats backend, BackendMetaConstraints backend, SqlConcat backend, InterpreterBackendSupport backend, Typeable backend, NapkinParserDialect backend, BackendName backend, BackendPrograms backend)
- type CliAction (m :: k -> Type) (a :: k) = forall b. LoadYamlConstraint b => YamlSpec b -> Value -> m a
- loadYamlFile :: MonadIO m => SpecFilesWithOverrides -> CliAction m a -> m (Either NapkinError a)
- loadYamlFile' :: (MonadError NapkinError m, MonadIO m) => SpecFilesWithOverrides -> CliAction m a -> m a
- data YamlBackend = LoadYamlConstraint b => YamlBackend (Proxy b)
- loadYaml' :: Monad m => Value -> Maybe Patch -> CliAction m a -> m (Either Text a)
- loadHaskellModules :: forall bk m. MonadIO m => InterpreterInstance -> YamlSpec bk -> m (Either HaskellEvaluationError ())
- interpretTables :: forall bk (m :: Type -> Type). (Typeable bk, MonadIO m) => InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ())
- interpretHaskellSpec :: Typeable bk => InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError (Spec bk) ()
- interpretYamlToSpec :: forall b (m :: Type -> Type). (MonadIO m, Typeable b) => LogEnv -> RuntimeEnv -> YamlSpec b -> SpecMetaArgs -> ExceptT NapkinError m (RawInterpretedSpec b)
- interpretYamlToSpec' :: forall b (m :: Type -> Type). (MonadIO m, Typeable b) => LogEnv -> RuntimeEnv -> YamlSpec b -> SpecMetaArgs -> ExceptT YamlSpecInterpretError m (RawInterpretedSpec b)
- interpretTable :: forall bk (m :: Type -> Type). (MonadIO m, Typeable bk) => InterpreterInstance -> SpecTableName -> YamlTableSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ())
- interpretSpec :: Typeable b => InterpreterInstance -> Typed (Spec b ()) ModuleFunction -> ExceptT HaskellEvaluationError (Spec b) ()
- evalHsFun :: forall (m :: Type -> Type) b. (Typeable b, MonadIO m) => InterpreterInstance -> Typed b ModuleFunction -> ExceptT HaskellEvaluationError m b
- specMerge :: SpecFileArrayMergeStrategy -> Value -> Value -> Value
Documentation
newtype YamlParseError #
Constructors
| YamlParseError Text |
Instances
| Exception YamlParseError # | |
Defined in Napkin.Spec.Yaml.Interpret Methods toException :: YamlParseError -> SomeException # fromException :: SomeException -> Maybe YamlParseError # displayException :: YamlParseError -> String # backtraceDesired :: YamlParseError -> Bool # | |
| Show YamlParseError # | |
Defined in Napkin.Spec.Yaml.Interpret Methods showsPrec :: Int -> YamlParseError -> ShowS # show :: YamlParseError -> String # showList :: [YamlParseError] -> ShowS # | |
| Eq YamlParseError # | |
Defined in Napkin.Spec.Yaml.Interpret Methods (==) :: YamlParseError -> YamlParseError -> Bool # (/=) :: YamlParseError -> YamlParseError -> Bool # | |
type LoadYamlConstraint backend = (SpecBackend backend, Default (DbBackendOptions backend), Show (DbBackendOptions backend), FromJSON (DbBackendOptions backend), Eq (BackendTableMeta backend), Show (BackendTableMeta backend), RunBackendEffect backend, RunBackendConn backend, DumpBackendRequirements backend, HasBackendQueryStats backend, BackendMetaConstraints backend, SqlConcat backend, InterpreterBackendSupport backend, Typeable backend, NapkinParserDialect backend, BackendName backend, BackendPrograms backend) #
type CliAction (m :: k -> Type) (a :: k) = forall b. LoadYamlConstraint b => YamlSpec b -> Value -> m a #
loadYamlFile :: MonadIO m => SpecFilesWithOverrides -> CliAction m a -> m (Either NapkinError a) #
loadYamlFile' :: (MonadError NapkinError m, MonadIO m) => SpecFilesWithOverrides -> CliAction m a -> m a #
data YamlBackend #
Constructors
| LoadYamlConstraint b => YamlBackend (Proxy b) |
Instances
| FromJSON YamlBackend # | |
Defined in Napkin.Spec.Yaml.Interpret | |
loadHaskellModules :: forall bk m. MonadIO m => InterpreterInstance -> YamlSpec bk -> m (Either HaskellEvaluationError ()) #
The main entry point interpreting a given YAML spec file as a
Spec value ready to run via executeSpec
This function is intended to unroll/interpret as much as possible to get the spec in its final state ready to be actually run.
interpretTables :: forall bk (m :: Type -> Type). (Typeable bk, MonadIO m) => InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ()) #
interpretHaskellSpec :: Typeable bk => InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError (Spec bk) () #
interpretYamlToSpec :: forall b (m :: Type -> Type). (MonadIO m, Typeable b) => LogEnv -> RuntimeEnv -> YamlSpec b -> SpecMetaArgs -> ExceptT NapkinError m (RawInterpretedSpec b) #
interpretYamlToSpec' :: forall b (m :: Type -> Type). (MonadIO m, Typeable b) => LogEnv -> RuntimeEnv -> YamlSpec b -> SpecMetaArgs -> ExceptT YamlSpecInterpretError m (RawInterpretedSpec b) #
interpretTable :: forall bk (m :: Type -> Type). (MonadIO m, Typeable bk) => InterpreterInstance -> SpecTableName -> YamlTableSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ()) #
Main entry point for fully interpreting a given table's entry in the YAML file.
interpretSpec :: Typeable b => InterpreterInstance -> Typed (Spec b ()) ModuleFunction -> ExceptT HaskellEvaluationError (Spec b) () #
evalHsFun :: forall (m :: Type -> Type) b. (Typeable b, MonadIO m) => InterpreterInstance -> Typed b ModuleFunction -> ExceptT HaskellEvaluationError m b #