Extism

A Haskell Extism host

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

Documentation

data Manifest

Instances

Show Manifest

Defined in Extism.Manifest

Methods

showsPrec :: Int -> Manifest -> ShowS

show :: Manifest -> String

showList :: [Manifest] -> ShowS

PluginInput Manifest

Defined in Extism

Methods

pluginInput :: Manifest -> ByteString

Eq Manifest

Defined in Extism.Manifest

Methods

(==) :: Manifest -> Manifest -> Bool

(/=) :: Manifest -> Manifest -> Bool

JSON Manifest

Defined in Extism.Manifest

Methods

readJSON :: JSValue -> Result Manifest

showJSON :: Manifest -> JSValue

readJSONs :: JSValue -> Result [Manifest]

showJSONs :: [Manifest] -> JSValue

module Extism.Encoding

data Function

Host function, see hostFunction

Constructors

Function (ForeignPtr ExtismFunction) (StablePtr ())

Instances

Eq Function

Defined in Extism

Methods

(==) :: Function -> Function -> Bool

(/=) :: Function -> Function -> Bool

newtype Plugin

Plugins can be used to call WASM function

Constructors

Plugin (ForeignPtr ExtismPlugin)

Instances

Show Plugin

Defined in Extism

Methods

showsPrec :: Int -> Plugin -> ShowS

show :: Plugin -> String

showList :: [Plugin] -> ShowS

Eq Plugin

Defined in Extism

Methods

(==) :: Plugin -> Plugin -> Bool

(/=) :: Plugin -> Plugin -> Bool

newtype CancelHandle

Cancellation handle for Plugins

Constructors

CancelHandle (Ptr ExtismCancelHandle)

Instances

Show CancelHandle

Defined in Extism

Methods

showsPrec :: Int -> CancelHandle -> ShowS

show :: CancelHandle -> String

showList :: [CancelHandle] -> ShowS

Eq CancelHandle

Defined in Extism

Methods

(==) :: CancelHandle -> CancelHandle -> Bool

(/=) :: CancelHandle -> CancelHandle -> Bool

data LogLevel

Log level

Constructors

LogError

LogWarn

LogInfo

LogDebug

LogTrace

Instances

Show LogLevel

Defined in Extism

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Eq LogLevel

Defined in Extism

Methods

(==) :: LogLevel -> LogLevel -> Bool

(/=) :: LogLevel -> LogLevel -> Bool

newtype Error

Extism error

Constructors

ExtismError String

Instances

Show Error

Defined in Extism.Encoding

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

Eq Error

Defined in Extism.Encoding

Methods

(==) :: Error -> Error -> Bool

(/=) :: Error -> Error -> Bool

type Result a = Either Error a

Result type

extismVersion :: () -> IO String

Get the Extism version string

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

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

isValid :: Plugin -> IO Bool

Check if a Plugin is valid

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

Set configuration values for a plugin

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

cancelHandle :: Plugin -> IO CancelHandle

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

cancel :: CancelHandle -> IO Bool

Cancel a running plugin using a CancelHandle

pluginID :: Plugin -> IO UUID

unwrap :: Either Error b -> b

class ToBytes a where

Methods

toBytes :: a -> ByteString

Instances

ToBytes Int32

Defined in Extism.Encoding

Methods

toBytes :: Int32 -> ByteString

ToBytes Int64

Defined in Extism.Encoding

Methods

toBytes :: Int64 -> ByteString

ToBytes Word32

Defined in Extism.Encoding

Methods

toBytes :: Word32 -> ByteString

ToBytes Word64

Defined in Extism.Encoding

Methods

toBytes :: Word64 -> ByteString

ToBytes ByteString

Defined in Extism.Encoding

Methods

toBytes :: ByteString -> ByteString

ToBytes ()

Defined in Extism.Encoding

Methods

toBytes :: () -> ByteString

ToBytes Double

Defined in Extism.Encoding

Methods

toBytes :: Double -> ByteString

ToBytes Float

Defined in Extism.Encoding

Methods

toBytes :: Float -> ByteString

Data a => ToBytes (JSON a)

Defined in Extism.Encoding

Methods

toBytes :: JSON a -> ByteString

ToBytes [Char]

Defined in Extism.Encoding

Methods

toBytes :: [Char] -> ByteString

class FromBytes a where

Methods

fromBytes :: ByteString -> Result a

Instances

FromBytes Int32

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result Int32

FromBytes Int64

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result Int64

FromBytes Word32

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result Word32

FromBytes Word64

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result Word64

FromBytes ByteString

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result ByteString

FromBytes ()

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result ()

FromBytes Double

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result Double

FromBytes Float

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result Float

Data a => FromBytes (JSON a)

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result (JSON a)

FromBytes [Char]

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result [Char]

newtype JSON x

Constructors

JSON x

Instances

Data a => FromBytes (JSON a)

Defined in Extism.Encoding

Methods

fromBytes :: ByteString -> Result (JSON a)

Data a => ToBytes (JSON a)

Defined in Extism.Encoding

Methods

toBytes :: JSON a -> ByteString

class PluginInput a where

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

Methods

pluginInput :: a -> ByteString

Instances

PluginInput ByteString

Defined in Extism

Methods

pluginInput :: ByteString -> ByteString

PluginInput Manifest

Defined in Extism

Methods

pluginInput :: Manifest -> ByteString

reset :: Plugin -> IO ()