Safe Haskell	Safe-Inferred
Language	Haskell2010

Extism

Synopsis

type Result a = Either Error a
newtype Error = ExtismError String
type CurrentPlugin = Ptr ExtismCurrentPlugin
newtype Context = Context (ForeignPtr ExtismContext)
data Function = Function (ForeignPtr ExtismFunction) (StablePtr ())
data Plugin = Plugin Context Int32 [Function]
newtype CancelHandle = CancelHandle (Ptr ExtismCancelHandle)
data LogLevel
- = Error
- | Warn
- | Info
- | Debug
- | Trace
free :: Plugin -> IO ()
reset :: Context -> IO ()
fromByteString :: ByteString -> String
update :: Plugin -> ByteString -> [Function] -> Bool -> IO (Result Plugin)
isValid :: Plugin -> Bool
plugin :: Context -> ByteString -> [Function] -> Bool -> IO (Result Plugin)
toByteString :: String -> ByteString
extismVersion :: () -> IO String
newContext :: IO Context
withContext :: (Context -> IO a) -> IO a
withPlugin :: (Plugin -> IO a) -> Plugin -> IO a
createPlugin :: ByteString -> [Function] -> Bool -> IO (Result Plugin)
pluginFromManifest :: Context -> Manifest -> [Function] -> Bool -> IO (Result Plugin)
createPluginFromManifest :: Manifest -> [Function] -> Bool -> IO (Result Plugin)
updateManifest :: Plugin -> Manifest -> [Function] -> Bool -> IO (Result Plugin)
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
hostFunction :: String -> [ValType] -> [ValType] -> (CurrentPlugin -> [Val] -> a -> IO [Val]) -> a -> IO Function
toI32 :: Integral a => a -> Val
toI64 :: Integral a => a -> Val
toF32 :: Float -> Val
toF64 :: Double -> Val
fromI32 :: Integral a => Val -> Maybe a
fromI64 :: Integral a => Val -> Maybe a
fromF32 :: Val -> Maybe Float
fromF64 :: Val -> Maybe Double
data Manifest
toString :: JSON a => a -> String
data ValType
- = I32
- | I64
- | F32
- | F64
- | V128
- | FuncRef
- | ExternRef
data Val
- = ValI32 Int32
- | ValI64 Int64
- | ValF32 Float
- | ValF64 Double

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 #

type CurrentPlugin = Ptr ExtismCurrentPlugin Source #

Access the plugin that is currently executing from inside a host function

newtype Context Source #

Context for managing plugins

Constructors

Context (ForeignPtr ExtismContext)

data Function Source #

Host function

Constructors

Function (ForeignPtr ExtismFunction) (StablePtr ())

data Plugin Source #

Plugins can be used to call WASM function

Constructors

Plugin Context Int32 [Function]

newtype CancelHandle Source #

Cancellation handle for Plugins

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 -> [Function] -> Bool -> IO (Result Plugin) Source #

Update a Plugin with a new WASM module

isValid :: Plugin -> Bool Source #

Check if a Plugin is valid

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

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

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

withPlugin :: (Plugin -> IO a) -> Plugin -> IO a Source #

Execute a function with the provided Plugin as a parameter, then frees the Plugin | before returning the result.

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

Create a Plugin with its own Context

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

Create a Plugin from a Manifest

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

Create a Plugin with its own Context from a Manifest

updateManifest :: Plugin -> Manifest -> [Function] -> Bool -> IO (Result Plugin) 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 #

Create a new CancelHandle that can be used to cancel a running plugin | from another thread.

cancel :: CancelHandle -> IO Bool Source #

Cancel a running plugin using a CancelHandle

hostFunction :: String -> [ValType] -> [ValType] -> (CurrentPlugin -> [Val] -> a -> IO [Val]) -> a -> IO Function Source #

Create a new Function that can be called from a Plugin

toI32 :: Integral a => a -> Val Source #

Create a new I32 Val

toI64 :: Integral a => a -> Val Source #

Create a new I64 Val

toF32 :: Float -> Val Source #

Create a new F32 Val

toF64 :: Double -> Val Source #

Create a new F64 Val

fromI32 :: Integral a => Val -> Maybe a Source #

Get I32 Val

fromI64 :: Integral a => Val -> Maybe a Source #

Get I64 Val

fromF32 :: Val -> Maybe Float Source #

Get F32 Val

fromF64 :: Val -> Maybe Double Source #

Get F64 Val

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 #

data ValType Source #

Constructors

I32
I64
F32
F64
V128
FuncRef
ExternRef

Instances

Instances details

Storable ValType Source #
Instance details Defined in Extism.Bindings Methods sizeOf :: ValType -> Int # alignment :: ValType -> Int # peekElemOff :: Ptr ValType -> Int -> IO ValType # pokeElemOff :: Ptr ValType -> Int -> ValType -> IO () # peekByteOff :: Ptr b -> Int -> IO ValType # pokeByteOff :: Ptr b -> Int -> ValType -> IO () # peek :: Ptr ValType -> IO ValType # poke :: Ptr ValType -> ValType -> IO () #
Show ValType Source #
Instance details Defined in Extism.Bindings Methods showsPrec :: Int -> ValType -> ShowS # show :: ValType -> String # showList :: [ValType] -> ShowS #
Eq ValType Source #
Instance details Defined in Extism.Bindings Methods (==) :: ValType -> ValType -> Bool # (/=) :: ValType -> ValType -> Bool #

data Val Source #

Constructors

ValI32 Int32
ValI64 Int64
ValF32 Float
ValF64 Double

Instances

Instances details

Storable Val Source #
Instance details Defined in Extism.Bindings Methods sizeOf :: Val -> Int # alignment :: Val -> Int # peekElemOff :: Ptr Val -> Int -> IO Val # pokeElemOff :: Ptr Val -> Int -> Val -> IO () # peekByteOff :: Ptr b -> Int -> IO Val # pokeByteOff :: Ptr b -> Int -> Val -> IO () # peek :: Ptr Val -> IO Val # poke :: Ptr Val -> Val -> IO () #
Show Val Source #
Instance details Defined in Extism.Bindings Methods showsPrec :: Int -> Val -> ShowS # show :: Val -> String # showList :: [Val] -> ShowS #
Eq Val Source #
Instance details Defined in Extism.Bindings Methods (==) :: Val -> Val -> Bool # (/=) :: Val -> Val -> Bool #