Extism.PDK.Memory

Extism.PDK.Memory implements a low-level interface for interacting with Extism memory

Documentation

data Memory

Represents a block of memory by offset and length

Constructors

Memory MemoryOffset MemoryLength

type MemoryOffset = Word64

Offset in Extism memory

type MemoryLength = Word64

Length of allocated block of memory

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

Data a => FromBytes (JSON a)

Defined in Extism.PDK.Memory

Methods

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

MsgPack a => FromBytes (MsgPack a)

Defined in Extism.PDK.Memory

Methods

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

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

Data a => ToBytes (JSON a)

Defined in Extism.PDK.Memory

Methods

toBytes :: JSON a -> ByteString

MsgPack a => ToBytes (MsgPack a)

Defined in Extism.PDK.Memory

Methods

toBytes :: MsgPack a -> ByteString

newtype JSON a

A wrapper type for JSON encoded values

Constructors

JSON a

Instances

Data a => FromBytes (JSON a)

Defined in Extism.PDK.Memory

Methods

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

Data a => ToBytes (JSON a)

Defined in Extism.PDK.Memory

Methods

toBytes :: JSON a -> ByteString

newtype MsgPack a

A wrapper type for MsgPack encoded values

Constructors

MsgPack a

Instances

MsgPack a => FromBytes (MsgPack a)

Defined in Extism.PDK.Memory

Methods

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

MsgPack a => ToBytes (MsgPack a)

Defined in Extism.PDK.Memory

Methods

toBytes :: MsgPack a -> ByteString

load :: FromBytes a => Memory -> IO (Either String a)

Load data from Memory block

loadString :: Memory -> IO String

Load string from Memory block

loadByteString :: Memory -> IO ByteString

Load ByteString from Memory block

outputMemory :: Memory -> IO ()

Set plugin output to the provided Memory block

memAlloc :: Int -> IO Memory

Allocate a new Memory block

free :: Memory -> IO ()

Free a Memory block

alloc :: ToBytes a => a -> IO Memory

Encode a value and copy it into Extism memory, returning the Memory block

allocString :: String -> IO Memory

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

allocByteString :: ByteString -> IO Memory

Allocate a new Memory block and copy the encoded value

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