Neovim.Plugin.IPC.Classes

Documentation

data SomeMessage

Taken from xmonad and based on ideas in /An Extensible Dynamically-Typed Hierarchy of Exceptions/, Simon Marlow, 2006.

User-extensible messages must be put into a value of this type, so that it can be sent to other plugins.

Constructors

Message msg => SomeMessage msg

class Typeable message => Message message where

This class allows type safe casting of SomeMessage to an actual message. The cast is successful if the type you're expecting matches the type in the SomeMessage wrapper. This way, you can subscribe to an arbitrary message type withouth having to pattern match on the constructors. This also allows plugin authors to create their own message types without having to change the core code of nvim-hs.

Methods

fromMessage :: SomeMessage -> Maybe message

Try to convert a given message to a value of the message type we are interested in. Will evaluate to Nothing for any other type.

Instances

Message Notification

Methods

fromMessage :: SomeMessage -> Maybe Notification

Message Request

Methods

fromMessage :: SomeMessage -> Maybe Request

Message FunctionCall

Methods

fromMessage :: SomeMessage -> Maybe FunctionCall

Message Message

Methods

fromMessage :: SomeMessage -> Maybe Message

data FunctionCall

Haskell representation of supported Remote Procedure Call messages.

Constructors

FunctionCall FunctionName [Object] (TMVar (Either Object Object)) UTCTime

Method name, parameters, callback, timestamp

Instances

Pretty FunctionCall

Methods

pretty :: FunctionCall -> Doc

prettyList :: [FunctionCall] -> Doc

Message FunctionCall

Methods

fromMessage :: SomeMessage -> Maybe FunctionCall

data Request

A request is a data type containing the method to call, its arguments and an identifier used to map the result to the function that has been called.

Constructors

Request

Fields

• reqMethod :: FunctionName

  Name of the function to call.

• reqId :: !Int64

  Identifier to map the result to a function call invocation.

• reqArgs :: [Object]

  Arguments for the function.

Instances

Eq Request

Methods

(==) :: Request -> Request -> Bool

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

Ord Request

Methods

compare :: Request -> Request -> Ordering

(<) :: Request -> Request -> Bool

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

(>) :: Request -> Request -> Bool

(>=) :: Request -> Request -> Bool

max :: Request -> Request -> Request

min :: Request -> Request -> Request

Show Request

Methods

showsPrec :: Int -> Request -> ShowS

show :: Request -> String

showList :: [Request] -> ShowS

Pretty Request

Methods

pretty :: Request -> Doc

prettyList :: [Request] -> Doc

Message Request

Methods

fromMessage :: SomeMessage -> Maybe Request

data Notification

A notification is similar to a Request. It essentially does the same thing, but the function is only called for its side effects. This type of message is sent by neovim if the caller there does not care about the result of the computation.

Constructors

Notification

Fields

• notMethod :: FunctionName

  Name of the function to call.

• notArgs :: [Object]

  Arguments for the function.

Instances

Eq Notification

Methods

(==) :: Notification -> Notification -> Bool

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

Ord Notification

Methods

compare :: Notification -> Notification -> Ordering

(<) :: Notification -> Notification -> Bool

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

(>) :: Notification -> Notification -> Bool

(>=) :: Notification -> Notification -> Bool

max :: Notification -> Notification -> Notification

min :: Notification -> Notification -> Notification

Show Notification

Methods

showsPrec :: Int -> Notification -> ShowS

show :: Notification -> String

showList :: [Notification] -> ShowS

Pretty Notification

Methods

pretty :: Notification -> Doc

prettyList :: [Notification] -> Doc

Message Notification

Methods

fromMessage :: SomeMessage -> Maybe Notification

module Data.Int

module Data.Time