Safe Haskell	None
Language	Haskell2010

Extism

Description

A Haskell Extism host

Requires a libextism installation, see https://extism.org/docs/install

Synopsis

data Manifest
module Extism.Encoding
data Function = Function (ForeignPtr ExtismFunction) (StablePtr ())
newtype Plugin = Plugin (ForeignPtr ExtismPlugin)
newtype CancelHandle = CancelHandle (Ptr ExtismCancelHandle)
data LogLevel
- = LogError
- | LogWarn
- | LogInfo
- | LogDebug
- | LogTrace
newtype Error = ExtismError String
type Result a = Either Error a
extismVersion :: () -> IO String
newPlugin :: PluginInput a => a -> [Function] -> Bool -> IO (Result Plugin)
newCompiledPlugin :: PluginInput a => a -> [Function] -> Bool -> IO (Result CompiledPlugin)
newPluginFromCompiled :: CompiledPlugin -> IO (Result Plugin)
isValid :: Plugin -> IO Bool
setConfig :: Plugin -> [(String, Maybe String)] -> IO Bool
setLogFile :: String -> LogLevel -> IO Bool
functionExists :: Plugin -> String -> IO Bool
call :: (ToBytes a, FromBytes b) => Plugin -> String -> a -> IO (Result b)
call' :: (ToBytes a, FromBytes b) => Plugin -> String -> a -> IO b
callWithHostContext :: (ToBytes a, FromBytes b) => Plugin -> String -> a -> c -> IO (Result b)
callWithHostContext' :: (ToBytes a, FromBytes b) => Plugin -> String -> a -> c -> IO b
cancelHandle :: Plugin -> IO CancelHandle
cancel :: CancelHandle -> IO Bool
pluginID :: Plugin -> IO UUID
unwrap :: Either Error b -> b
class ToBytes a where
- toBytes :: a -> ByteString
class FromBytes a where
- fromBytes :: ByteString -> Result a
newtype JSON x = JSON x
class PluginInput a where
- pluginInput :: a -> ByteString
reset :: Plugin -> IO ()

Documentation

data Manifest #

Instances

Instances details

PluginInput Manifest Source #
Instance details Defined in Extism Methods pluginInput :: Manifest -> ByteString Source #
Show Manifest
Instance details Defined in Extism.Manifest Methods showsPrec :: Int -> Manifest -> ShowS # show :: Manifest -> String # showList :: [Manifest] -> ShowS #
Eq Manifest
Instance details Defined in Extism.Manifest Methods (==) :: Manifest -> Manifest -> Bool # (/=) :: Manifest -> Manifest -> Bool #
JSON Manifest
Instance details Defined in Extism.Manifest Methods readJSON :: JSValue -> Result Manifest # showJSON :: Manifest -> JSValue # readJSONs :: JSValue -> Result [Manifest] # showJSONs :: [Manifest] -> JSValue #

module Extism.Encoding

data Function Source #

Host function, see hostFunction

Constructors

Function (ForeignPtr ExtismFunction) (StablePtr ())

Instances

Instances details

Eq Function Source #
Instance details Defined in Extism Methods (==) :: Function -> Function -> Bool # (/=) :: Function -> Function -> Bool #

newtype Plugin Source #

Plugins can be used to call WASM function

Constructors

Plugin (ForeignPtr ExtismPlugin)

Instances

Instances details

Show Plugin Source #
Instance details Defined in Extism Methods showsPrec :: Int -> Plugin -> ShowS # show :: Plugin -> String # showList :: [Plugin] -> ShowS #
Eq Plugin Source #
Instance details Defined in Extism Methods (==) :: Plugin -> Plugin -> Bool # (/=) :: Plugin -> Plugin -> Bool #

newtype CancelHandle Source #

Cancellation handle for Plugins

Constructors

CancelHandle (Ptr ExtismCancelHandle)

Instances

Instances details

Show CancelHandle Source #
Instance details Defined in Extism Methods showsPrec :: Int -> CancelHandle -> ShowS # show :: CancelHandle -> String # showList :: [CancelHandle] -> ShowS #
Eq CancelHandle Source #
Instance details Defined in Extism Methods (==) :: CancelHandle -> CancelHandle -> Bool # (/=) :: CancelHandle -> CancelHandle -> Bool #

data LogLevel Source #

Log level

Constructors

LogError
LogWarn
LogInfo
LogDebug
LogTrace

Instances

Instances details

Show LogLevel Source #
Instance details Defined in Extism Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #
Eq LogLevel Source #
Instance details Defined in Extism Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #

newtype Error Source #

Extism error

Constructors

ExtismError String

Instances

Instances details

Show Error Source #
Instance details Defined in Extism.Encoding Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
Eq Error Source #
Instance details Defined in Extism.Encoding Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #

type Result a = Either Error a Source #

Result type

extismVersion :: () -> IO String Source #

Get the Extism version string

newPlugin :: PluginInput a => a -> [Function] -> Bool -> IO (Result Plugin) Source #

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

newCompiledPlugin :: PluginInput a => a -> [Function] -> Bool -> IO (Result CompiledPlugin) Source #

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

newPluginFromCompiled :: CompiledPlugin -> IO (Result Plugin) Source #

Create a new plugin from a CompiledPlugin

isValid :: Plugin -> IO Bool Source #

Check if a Plugin is valid

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

Set configuration values for a plugin

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 :: (ToBytes a, FromBytes b) => Plugin -> String -> a -> IO (Result b) Source #

call' :: (ToBytes a, FromBytes b) => Plugin -> String -> a -> IO b Source #

callWithHostContext :: (ToBytes a, FromBytes b) => Plugin -> String -> a -> c -> IO (Result b) Source #

callWithHostContext' :: (ToBytes a, FromBytes b) => Plugin -> String -> a -> c -> IO b 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

pluginID :: Plugin -> IO UUID Source #

unwrap :: Either Error b -> b Source #

class ToBytes a where Source #

Methods

toBytes :: a -> ByteString Source #

Instances

Instances details

ToBytes ByteString Source #
Instance details Defined in Extism.Encoding Methods toBytes :: ByteString -> ByteString Source #
ToBytes Int32 Source #
Instance details Defined in Extism.Encoding Methods toBytes :: Int32 -> ByteString Source #
ToBytes Int64 Source #
Instance details Defined in Extism.Encoding Methods toBytes :: Int64 -> ByteString Source #
ToBytes Word32 Source #
Instance details Defined in Extism.Encoding Methods toBytes :: Word32 -> ByteString Source #
ToBytes Word64 Source #
Instance details Defined in Extism.Encoding Methods toBytes :: Word64 -> ByteString Source #
ToBytes () Source #
Instance details Defined in Extism.Encoding Methods toBytes :: () -> ByteString Source #
ToBytes Double Source #
Instance details Defined in Extism.Encoding Methods toBytes :: Double -> ByteString Source #
ToBytes Float Source #
Instance details Defined in Extism.Encoding Methods toBytes :: Float -> ByteString Source #
Data a => ToBytes (JSON a) Source #
Instance details Defined in Extism.Encoding Methods toBytes :: JSON a -> ByteString Source #
ToBytes [Char] Source #
Instance details Defined in Extism.Encoding Methods toBytes :: [Char] -> ByteString Source #

class FromBytes a where Source #

Methods

fromBytes :: ByteString -> Result a Source #

Instances

Instances details

FromBytes ByteString Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result ByteString Source #
FromBytes Int32 Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result Int32 Source #
FromBytes Int64 Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result Int64 Source #
FromBytes Word32 Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result Word32 Source #
FromBytes Word64 Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result Word64 Source #
FromBytes () Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result () Source #
FromBytes Double Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result Double Source #
FromBytes Float Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result Float Source #
Data a => FromBytes (JSON a) Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result (JSON a) Source #
FromBytes [Char] Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result [Char] Source #

newtype JSON x Source #

Constructors

JSON x

Instances

Instances details

Data a => FromBytes (JSON a) Source #
Instance details Defined in Extism.Encoding Methods fromBytes :: ByteString -> Result (JSON a) Source #
Data a => ToBytes (JSON a) Source #
Instance details Defined in Extism.Encoding Methods toBytes :: JSON a -> ByteString Source #

class PluginInput a where Source #

Defines types that can be used to pass Wasm data into a plugin

Methods

pluginInput :: a -> ByteString Source #

Instances

Instances details

PluginInput ByteString Source #
Instance details Defined in Extism Methods pluginInput :: ByteString -> ByteString Source #
PluginInput Manifest Source #
Instance details Defined in Extism Methods pluginInput :: Manifest -> ByteString Source #

reset :: Plugin -> IO () Source #