Extism.PDK

Extism plugin development kit, used with the wasm32-wasi-ghc backend to make Extism plugins

Documentation

data LogLevel

Log level

Constructors

Info

Debug

Warn

Error

log :: LogLevel -> String -> IO ()

Log to configured log file

tryInput :: FromBytes a => IO (Either String a)

Get plugin input, returning an error message if the encoding is invalid

inputByteString :: IO ByteString

Get plugin input as a ByteString

input :: forall a. FromBytes a => IO a

Get plugin input

inputString :: IO String

Get plugin input as a String

inputJSON :: JSON a => IO (Either String a)

Get input as JSON, this is similar to calling `input (JsonValue ...)`

output :: ToBytes a => a -> IO ()

Set plugin output

outputJSON :: JSON a => a -> IO ()

Set plugin output to a JSON encoded version of the provided value

getVar :: FromBytes a => String -> IO (Maybe a)

Get a variable from the Extism runtime

setVar :: ToBytes a => String -> Maybe a -> IO ()

Set a variable

getConfig :: String -> IO (Maybe String)

Get a configuration value

setError :: String -> IO ()

Set the current error message

class ToBytes a where

A class used to convert values to bytes to be written into linear memory

Methods

toBytes :: a -> ByteString

Instances

ToBytes Int32

Defined in Extism.PDK.Memory

Methods

toBytes :: Int32 -> ByteString

ToBytes Int64

Defined in Extism.PDK.Memory

Methods

toBytes :: Int64 -> ByteString

ToBytes Word32

Defined in Extism.PDK.Memory

Methods

toBytes :: Word32 -> ByteString

ToBytes Word64

Defined in Extism.PDK.Memory

Methods

toBytes :: Word64 -> ByteString

ToBytes ByteString

Defined in Extism.PDK.Memory

Methods

toBytes :: ByteString -> ByteString

ToBytes String

Defined in Extism.PDK.Memory

Methods

toBytes :: String -> ByteString

ToBytes Double

Defined in Extism.PDK.Memory

Methods

toBytes :: Double -> ByteString

ToBytes Float

Defined in Extism.PDK.Memory

Methods

toBytes :: Float -> ByteString

JSON a => ToBytes (JSONValue a)

Defined in Extism.PDK.Memory

Methods

toBytes :: JSONValue a -> ByteString

MsgPack a => ToBytes (MsgPackValue a)

Defined in Extism.PDK.Memory

Methods

toBytes :: MsgPackValue a -> ByteString

class FromBytes a where

A class used to convert values from bytes read from linear memory

Methods

fromBytes :: ByteString -> Either String a

Instances

FromBytes Int32

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String Int32

FromBytes Int64

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String Int64

FromBytes Word32

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String Word32

FromBytes Word64

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String Word64

FromBytes ByteString

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String ByteString

FromBytes String

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String String

FromBytes Double

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String Double

FromBytes Float

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String Float

JSON a => FromBytes (JSONValue a)

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String (JSONValue a)

MsgPack a => FromBytes (MsgPackValue a)

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String (MsgPackValue a)

newtype JSONValue a

A wrapper type for JSON encoded values

Constructors

JSONValue a

Instances

JSON a => FromBytes (JSONValue a)

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String (JSONValue a)

JSON a => ToBytes (JSONValue a)

Defined in Extism.PDK.Memory

Methods

toBytes :: JSONValue a -> ByteString

newtype MsgPackValue a

A wrapper type for MsgPack encoded values

Constructors

MsgPackValue a

Instances

MsgPack a => FromBytes (MsgPackValue a)

Defined in Extism.PDK.Memory

Methods

fromBytes :: ByteString -> Either String (MsgPackValue a)

MsgPack a => ToBytes (MsgPackValue a)

Defined in Extism.PDK.Memory

Methods

toBytes :: MsgPackValue a -> ByteString