OCaml.BuckleScript.Internal.Module

Documentation

data OCamlModule (modules :: [Symbol])

An OCamlModule as a Haskell type. File level modules is relative to a root directory prvoiided in the mkPackage function.

Instances

(KnownSymbols modules, HasOCamlTypeMetaData' k1 api) => HasOCamlTypeMetaData * ((:>) * k1 (OCamlModule modules) api)

single module

Methods

mkOCamlTypeMetaData :: Proxy ((* :> k1) (OCamlModule modules) api) a -> Map HaskellTypeMetaData OCamlTypeMetaData

(KnownSymbols modules, HasOCamlModule' k1 api) => HasOCamlModule * ((:>) * k1 (OCamlModule modules) api)

Methods

mkModule :: Proxy ((* :> k1) (OCamlModule modules) api) a -> PackageOptions -> Map HaskellTypeMetaData OCamlTypeMetaData -> IO ()

data OCamlSubModule (subModules :: Symbol)

Symobl will be expaneded to "module SymbolName = struct ... end".

data OCamlTypeInFile a (filePath :: Symbol)

A handwritten OCaml type, encoder and decoder from a file.

data EmbeddedOCamlFiles

Store OCamlFileInType data.

Constructors

EmbeddedOCamlFiles

Fields

• eocDeclaration :: ByteString
• eocInterface :: Maybe ByteString
• eocSpec :: Maybe ByteString

Instances

Show EmbeddedOCamlFiles

Methods

showsPrec :: Int -> EmbeddedOCamlFiles -> ShowS

show :: EmbeddedOCamlFiles -> String

showList :: [EmbeddedOCamlFiles] -> ShowS

class HasOCamlType api where

Convert a Haskell type into OCaml source code.

Minimal complete definition

mkType, mkInterface, mkSpec

Methods

mkType :: Proxy api -> Options -> Bool -> Map String EmbeddedOCamlFiles -> [Text]

mkInterface :: Proxy api -> Options -> Map String EmbeddedOCamlFiles -> [Text]

mkSpec :: Proxy api -> Options -> [Text] -> Text -> Text -> Map String EmbeddedOCamlFiles -> [Text]

Instances

((~) Nat (HasOCamlTypeFlag a) flag, HasOCamlType' * flag a) => HasOCamlType * a

Methods

mkType :: Proxy a api -> Options -> Bool -> Map String EmbeddedOCamlFiles -> [Text]

mkInterface :: Proxy a api -> Options -> Map String EmbeddedOCamlFiles -> [Text]

mkSpec :: Proxy a api -> Options -> [Text] -> Text -> Text -> Map String EmbeddedOCamlFiles -> [Text]

class HasEmbeddedFile api where

Use Template Haskell to load OCaml files for an OCaml Module at compile time. '$(mkFile (Proxy :: Proxy Package))'.

Minimal complete definition

mkFiles

Methods

mkFiles :: Bool -> Bool -> Proxy api -> Q Exp

Instances

HasEmbeddedFile' k api => HasEmbeddedFile k api

Methods

mkFiles :: Bool -> Bool -> Proxy api api -> Q Exp