Extism.PDK

Documentation

data Memory

Represents a block of memory

Constructors

Memory MemoryOffset MemoryLength

newtype JSONValue a

Constructors

JSONValue a

Instances

JSON a => FromBytes (JSONValue a)

Defined in Extism.PDK

Methods

fromBytes :: ByteString -> JSONValue a

JSON a => ToBytes (JSONValue a)

Defined in Extism.PDK

Methods

toBytes :: JSONValue a -> ByteString

newtype MsgPackValue a

Constructors

MsgPackValue a

Instances

MsgPack a => FromBytes (MsgPackValue a)

Defined in Extism.PDK

Methods

fromBytes :: ByteString -> MsgPackValue a

MsgPack a => ToBytes (MsgPackValue a)

Defined in Extism.PDK

Methods

toBytes :: MsgPackValue a -> ByteString

class FromBytes a where

Methods

fromBytes :: ByteString -> a

Instances

FromBytes ByteString

Defined in Extism.PDK

Methods

fromBytes :: ByteString -> ByteString

FromBytes String

Defined in Extism.PDK

Methods

fromBytes :: ByteString -> String

JSON a => FromBytes (JSONValue a)

Defined in Extism.PDK

Methods

fromBytes :: ByteString -> JSONValue a

MsgPack a => FromBytes (MsgPackValue a)

Defined in Extism.PDK

Methods

fromBytes :: ByteString -> MsgPackValue a

class ToBytes a where

Methods

toBytes :: a -> ByteString

Instances

ToBytes ByteString

Defined in Extism.PDK

Methods

toBytes :: ByteString -> ByteString

ToBytes String

Defined in Extism.PDK

Methods

toBytes :: String -> ByteString

JSON a => ToBytes (JSONValue a)

Defined in Extism.PDK

Methods

toBytes :: JSONValue a -> ByteString

MsgPack a => ToBytes (MsgPackValue a)

Defined in Extism.PDK

Methods

toBytes :: MsgPackValue a -> ByteString

data LogLevel

Constructors

Info

Debug

Warn

Error

free :: Memory -> IO ()

Free a Memory block

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

fromByteString :: ByteString -> String

Helper function to convert a bytestring to a string

toByteString :: String -> ByteString

Helper function to convert a string to a bytestring

input :: FromBytes a => IO a

Get plugin input as ByteString

inputMemory :: IO Memory

Get plugin input as Memory block

inputJSON :: JSON a => IO (Maybe a)

Get input as JSON

load :: FromBytes a => Memory -> IO a

Load data from Memory block

store :: ToBytes a => Memory -> a -> IO ()

Store data into a Memory block

outputMemory :: Memory -> IO ()

Set plugin output to the provided Memory block

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

Set plugin output to the provided ByteString

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

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

loadString :: Memory -> IO String

Load string from Memory block

storeString :: Memory -> String -> IO ()

Store string in Memory block

alloc :: Int -> IO Memory

Allocate a new Memory block

allocByteString :: ByteString -> IO Memory

Allocate a new Memory block and copy the contents of the provided ByteString

allocString :: String -> IO Memory

Allocate a new Memory block and copy the contents of the provided String

memoryOffset :: Memory -> MemoryOffset

Get the offset of a Memory block

memoryLength :: Memory -> MemoryLength

Get the length of a Memory block

findMemory :: MemoryOffset -> IO Memory

Find Memory block by offset

getVar :: String -> IO (Maybe ByteString)

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

toString :: JSON a => a -> String