Extism.HostFunction

Documentation

data CurrentPlugin

Access the plugin that is currently executing from inside a host function

Constructors

CurrentPlugin (Ptr ExtismCurrentPlugin) [Val] (Ptr Val) Int

data ValType

Low-level Wasm types

Constructors

I32

I64

F32

F64

V128

FuncRef

ExternRef

Instances

Storable ValType

Defined in Extism.Bindings

Methods

sizeOf :: ValType -> Int

alignment :: ValType -> Int

peekElemOff :: Ptr ValType -> Int -> IO ValType

pokeElemOff :: Ptr ValType -> Int -> ValType -> IO ()

peekByteOff :: Ptr b -> Int -> IO ValType

pokeByteOff :: Ptr b -> Int -> ValType -> IO ()

peek :: Ptr ValType -> IO ValType

poke :: Ptr ValType -> ValType -> IO ()

Show ValType

Defined in Extism.Bindings

Methods

showsPrec :: Int -> ValType -> ShowS

show :: ValType -> String

showList :: [ValType] -> ShowS

Eq ValType

Defined in Extism.Bindings

Methods

(==) :: ValType -> ValType -> Bool

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

data Val

Low-level Wasm values

Constructors

ValI32 Int32

ValI64 Int64

ValF32 Float

ValF64 Double

Instances

Storable Val

Defined in Extism.Bindings

Methods

sizeOf :: Val -> Int

alignment :: Val -> Int

peekElemOff :: Ptr Val -> Int -> IO Val

pokeElemOff :: Ptr Val -> Int -> Val -> IO ()

peekByteOff :: Ptr b -> Int -> IO Val

pokeByteOff :: Ptr b -> Int -> Val -> IO ()

peek :: Ptr Val -> IO Val

poke :: Ptr Val -> Val -> IO ()

Show Val

Defined in Extism.Bindings

Methods

showsPrec :: Int -> Val -> ShowS

show :: Val -> String

showList :: [Val] -> ShowS

Eq Val

Defined in Extism.Bindings

Methods

(==) :: Val -> Val -> Bool

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

data MemoryHandle

A memory handle represents an allocated block of Extism memory

Instances

Enum MemoryHandle

Defined in Extism.HostFunction

Methods

succ :: MemoryHandle -> MemoryHandle

pred :: MemoryHandle -> MemoryHandle

toEnum :: Int -> MemoryHandle

fromEnum :: MemoryHandle -> Int

enumFrom :: MemoryHandle -> [MemoryHandle]

enumFromThen :: MemoryHandle -> MemoryHandle -> [MemoryHandle]

enumFromTo :: MemoryHandle -> MemoryHandle -> [MemoryHandle]

enumFromThenTo :: MemoryHandle -> MemoryHandle -> MemoryHandle -> [MemoryHandle]

Num MemoryHandle

Defined in Extism.HostFunction

Methods

(+) :: MemoryHandle -> MemoryHandle -> MemoryHandle

(-) :: MemoryHandle -> MemoryHandle -> MemoryHandle

(*) :: MemoryHandle -> MemoryHandle -> MemoryHandle

negate :: MemoryHandle -> MemoryHandle

abs :: MemoryHandle -> MemoryHandle

signum :: MemoryHandle -> MemoryHandle

fromInteger :: Integer -> MemoryHandle

Integral MemoryHandle

Defined in Extism.HostFunction

Methods

quot :: MemoryHandle -> MemoryHandle -> MemoryHandle

rem :: MemoryHandle -> MemoryHandle -> MemoryHandle

div :: MemoryHandle -> MemoryHandle -> MemoryHandle

mod :: MemoryHandle -> MemoryHandle -> MemoryHandle

quotRem :: MemoryHandle -> MemoryHandle -> (MemoryHandle, MemoryHandle)

divMod :: MemoryHandle -> MemoryHandle -> (MemoryHandle, MemoryHandle)

toInteger :: MemoryHandle -> Integer

Real MemoryHandle

Defined in Extism.HostFunction

Methods

toRational :: MemoryHandle -> Rational

Show MemoryHandle

Defined in Extism.HostFunction

Methods

showsPrec :: Int -> MemoryHandle -> ShowS

show :: MemoryHandle -> String

showList :: [MemoryHandle] -> ShowS

Eq MemoryHandle

Defined in Extism.HostFunction

Methods

(==) :: MemoryHandle -> MemoryHandle -> Bool

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

Ord MemoryHandle

Defined in Extism.HostFunction

Methods

compare :: MemoryHandle -> MemoryHandle -> Ordering

(<) :: MemoryHandle -> MemoryHandle -> Bool

(<=) :: MemoryHandle -> MemoryHandle -> Bool

(>) :: MemoryHandle -> MemoryHandle -> Bool

(>=) :: MemoryHandle -> MemoryHandle -> Bool

max :: MemoryHandle -> MemoryHandle -> MemoryHandle

min :: MemoryHandle -> MemoryHandle -> MemoryHandle

data Function

Host function, see hostFunction

Instances

Eq Function

Defined in Extism

Methods

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

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

memoryAlloc :: CurrentPlugin -> Word64 -> IO MemoryHandle

Allocate a new handle of the given size

memoryLength :: CurrentPlugin -> MemoryHandle -> IO Word64

Get the length of a handle, returns 0 if the handle is invalid

memoryFree :: CurrentPlugin -> MemoryHandle -> IO ()

Free allocated memory

memory :: CurrentPlugin -> IO (Ptr Word8)

Access a pointer to the entire memory region

memoryOffset :: CurrentPlugin -> MemoryHandle -> IO (Ptr Word8)

Access the pointer for the given MemoryHandle

memoryBytes :: CurrentPlugin -> MemoryHandle -> IO ByteString

Access the data associated with a handle as a ByteString

memoryString :: CurrentPlugin -> MemoryHandle -> IO String

Access the data associated with a handle as a String

memoryGet :: FromBytes a => CurrentPlugin -> MemoryHandle -> IO (Result a)

Access the data associated with a handle and convert it into a Haskell type

allocBytes :: CurrentPlugin -> ByteString -> IO MemoryHandle

Allocate memory and copy an existing ByteString into it

allocString :: CurrentPlugin -> String -> IO MemoryHandle

Allocate memory and copy an existing String into it

alloc :: ToBytes a => CurrentPlugin -> a -> IO MemoryHandle

toI32 :: Integral a => a -> Val

Create a new I32 Val

toI64 :: Integral a => a -> Val

Create a new I64 Val

toF32 :: Float -> Val

Create a new F32 Val

toF64 :: Double -> Val

Create a new F64 Val

fromI32 :: Integral a => Val -> Maybe a

Get I32 Val

fromI64 :: Integral a => Val -> Maybe a

Get I64 Val

fromF32 :: Val -> Maybe Float

Get F32 Val

fromF64 :: Val -> Maybe Double

Get F64 Val

hostFunction :: String -> [ValType] -> [ValType] -> (CurrentPlugin -> a -> IO ()) -> a -> IO Function

hostFunction "function_name" inputTypes outputTypes callback userData creates a new | Function in the default namespace that can be called from a Plugin

hostFunction' :: String -> String -> [ValType] -> [ValType] -> (CurrentPlugin -> a -> IO ()) -> a -> IO Function

hostFunction' "namespace" "function_name" inputTypes outputTypes callback userData creates a new | Function in the provided namespace that can be called from a Plugin

newFunction :: String -> [ValType] -> [ValType] -> a -> (CurrentPlugin -> a -> IO ()) -> IO Function

newFunction' "function_name" inputTypes outputTypes userData callback creates a new | Function in the default namespace that can be called from a Plugin

newFunction' :: String -> String -> [ValType] -> [ValType] -> a -> (CurrentPlugin -> a -> IO ()) -> IO Function

newFunction' "namespace" "function_name" inputTypes outputTypes userData callback creates a new | Function in the provided namespace that can be called from a Plugin

input :: FromBytes a => CurrentPlugin -> Int -> IO (Result a)

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

getParams :: CurrentPlugin -> [Val]

setResults :: CurrentPlugin -> [Val] -> IO ()

hostContext :: CurrentPlugin -> IO (Maybe a)

ptr :: ValType