Neovim.RPC.FunctionCall

Documentation

acall :: NvimObject result => FunctionName -> [Object] -> Neovim r st (STM (Either NeovimException result))

Helper function that concurrently puts a Message in the event queue and returns an STM action that returns the result.

acall' :: NvimObject result => FunctionName -> [Object] -> Neovim r st (STM result)

Helper function similar to acall that throws a runtime exception if the result is an error object.

scall

Arguments

:: NvimObject result

=> FunctionName

-> [Object]

Parameters in an Object array

-> Neovim r st (Either NeovimException result)

result value of the call or the thrown exception

Call a neovim function synchronously. This function blocks until the result is available.

scall' :: NvimObject result => FunctionName -> [Object] -> Neovim r st result

Helper function similar to scall that throws a runtime exception if the result is an error object.

scallThrow :: NvimObject result => FunctionName -> [Object] -> Neovim r st result

Similar to scall, but throw a NeovimException instead of returning it.

atomically' :: MonadIO io => STM result -> io result

Lifted variant of atomically.

wait :: Neovim r st (STM result) -> Neovim r st result

Wait for the result of the STM action.

This action possibly blocks as it is an alias for ioSTM -> ioSTM >>= liftIO . atomically.

wait' :: Neovim r st (STM result) -> Neovim r st ()

Variant of wait that discards the result.

waitErr

Arguments

:: Pretty e

=> String

Prefix error message with this.

-> Neovim r st (STM (Either e result))

Function call to neovim

-> Neovim r st result

Wait for the result of the STM action and call err . (loc++) . show if the action returned an error.

waitErr' :: Pretty e => String -> Neovim r st (STM (Either e result)) -> Neovim r st ()

waitErr that discards the result.

respond :: NvimObject result => Request -> Either String result -> Neovim r st ()

Send the result back to the neovim instance.