Extism

Documentation

type Result a = Either Error a

Result type

newtype Error

Extism error

Constructors

ExtismError String

Instances

Show Error

Defined in Extism

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

data LogLevel

Log level

Constructors

Error

Warn

Info

Debug

Trace

Instances

Show LogLevel

Defined in Extism

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

data CancelHandle

Constructors

CancelHandle (Ptr ExtismCancelHandle)

data Plugin

Plugins can be used to call WASM function

Constructors

Plugin Context Int32

newtype Context

Context for managing plugins

Constructors

Context (ForeignPtr ExtismContext)

toByteString :: String -> ByteString

Helper function to convert a String to a ByteString

fromByteString :: ByteString -> String

Helper function to convert a ByteString to a String

extismVersion :: () -> IO String

Get the Extism version string

reset :: Context -> IO ()

Remove all registered plugins in a Context

newContext :: IO Context

Create a new Context

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

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

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

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

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

Create a Plugin from a Manifest

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

Update a Plugin with a new WASM module

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

Update a Plugin with a new Manifest

isValid :: Plugin -> Bool

Check if a Plugin is valid

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

Set configuration values for a plugin

levelStr :: LogLevel -> String

setLogFile :: String -> LogLevel -> IO Bool

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

functionExists :: Plugin -> String -> IO Bool

Check if a function exists in the given plugin

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

free :: Plugin -> IO ()

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

cancelHandle :: Plugin -> IO CancelHandle

cancel :: CancelHandle -> IO Bool

toString :: JSON a => a -> String

data Manifest

Instances

JSON Manifest

Defined in Extism.Manifest

Methods

readJSON :: JSValue -> Result Manifest

showJSON :: Manifest -> JSValue

readJSONs :: JSValue -> Result [Manifest]

showJSONs :: [Manifest] -> JSValue