Safe Haskell	Safe-Inferred
Language	Haskell2010

Extism

Synopsis

type Result a = Either Error a
newtype Error = ExtismError String
newtype Context = Context (ForeignPtr ExtismContext)
data Plugin = Plugin Context Int32
data CancelHandle = CancelHandle (Ptr ExtismCancelHandle)
data LogLevel
- = Error
- | Warn
- | Info
- | Debug
- | Trace
free :: Plugin -> IO ()
reset :: Context -> IO ()
fromByteString :: ByteString -> String
update :: Plugin -> ByteString -> Bool -> IO (Result ())
isValid :: Plugin -> Bool
toByteString :: String -> ByteString
extismVersion :: () -> IO String
newContext :: IO Context
withContext :: (Context -> IO a) -> IO a
plugin :: Context -> ByteString -> Bool -> IO (Result Plugin)
createPlugin :: ByteString -> Bool -> IO (Result Plugin)
pluginFromManifest :: Context -> Manifest -> Bool -> IO (Result Plugin)
createPluginFromManifest :: Manifest -> Bool -> IO (Result Plugin)
updateManifest :: Plugin -> Manifest -> Bool -> IO (Result ())
setConfig :: Plugin -> [(String, Maybe String)] -> IO Bool
levelStr :: LogLevel -> String
setLogFile :: String -> LogLevel -> IO Bool
functionExists :: Plugin -> String -> IO Bool
call :: Plugin -> String -> ByteString -> IO (Result ByteString)
cancelHandle :: Plugin -> IO CancelHandle
cancel :: CancelHandle -> IO Bool
data Manifest
toString :: JSON a => a -> String

Documentation

type Result a = Either Error a Source #

Result type

newtype Error Source #

Extism error

Constructors

ExtismError String

Instances

Instances details

Show Error Source #
Instance details Defined in Extism Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #

newtype Context Source #

Context for managing plugins

Constructors

Context (ForeignPtr ExtismContext)

data Plugin Source #

Plugins can be used to call WASM function

Constructors

Plugin Context Int32

data CancelHandle Source #

Constructors

CancelHandle (Ptr ExtismCancelHandle)

data LogLevel Source #

Log level

Constructors

Error
Warn
Info
Debug
Trace

Instances

Instances details

Show LogLevel Source #
Instance details Defined in Extism Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #

free :: Plugin -> IO () Source #

Free a Plugin, this will automatically be called for every plugin | associated with a Context when that Context is freed

reset :: Context -> IO () Source #

Remove all registered plugins in a Context

fromByteString :: ByteString -> String Source #

Helper function to convert a ByteString to a String

update :: Plugin -> ByteString -> Bool -> IO (Result ()) Source #

Update a Plugin with a new WASM module

isValid :: Plugin -> Bool Source #

Check if a Plugin is valid

toByteString :: String -> ByteString Source #

Helper function to convert a String to a ByteString

extismVersion :: () -> IO String Source #

Get the Extism version string

newContext :: IO Context Source #

Create a new Context

withContext :: (Context -> IO a) -> IO a Source #

Execute a function with a new Context that is destroyed when it returns

plugin :: Context -> ByteString -> Bool -> IO (Result Plugin) Source #

Create a Plugin from a WASM module, useWasi determines if WASI should | be linked

createPlugin :: ByteString -> Bool -> IO (Result Plugin) Source #

Create a Plugin with its own Context

pluginFromManifest :: Context -> Manifest -> Bool -> IO (Result Plugin) Source #

Create a Plugin from a Manifest

createPluginFromManifest :: Manifest -> Bool -> IO (Result Plugin) Source #

Create a Plugin with its own Context from a Manifest

updateManifest :: Plugin -> Manifest -> Bool -> IO (Result ()) Source #

Update a Plugin with a new Manifest

setConfig :: Plugin -> [(String, Maybe String)] -> IO Bool Source #

Set configuration values for a plugin

levelStr :: LogLevel -> String Source #

setLogFile :: String -> LogLevel -> IO Bool Source #

Set the log file and level, this is a global configuration

functionExists :: Plugin -> String -> IO Bool Source #

Check if a function exists in the given plugin

call :: Plugin -> String -> ByteString -> IO (Result ByteString) Source #

cancelHandle :: Plugin -> IO CancelHandle Source #

cancel :: CancelHandle -> IO Bool Source #

data Manifest #

Instances

Instances details

JSON Manifest
Instance details Defined in Extism.Manifest Methods readJSON :: JSValue -> Result Manifest # showJSON :: Manifest -> JSValue # readJSONs :: JSValue -> Result [Manifest] # showJSONs :: [Manifest] -> JSValue #

toString :: JSON a => a -> String #