Ribosome.Host.Data.Event

Events sent from Neovim to the host.

Documentation

newtype EventName

The name of an event, which corresponds to the RPC method in the payload.

Constructors

EventName

Fields

• unEventName :: Text

Instances

IsString EventName

Defined in Ribosome.Host.Data.Event

Methods

fromString :: String -> EventName

Show EventName

Defined in Ribosome.Host.Data.Event

Methods

showsPrec :: Int -> EventName -> ShowS

show :: EventName -> String

showList :: [EventName] -> ShowS

Eq EventName

Defined in Ribosome.Host.Data.Event

Methods

(==) :: EventName -> EventName -> Bool

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

Ord EventName

Defined in Ribosome.Host.Data.Event

Methods

compare :: EventName -> EventName -> Ordering

(<) :: EventName -> EventName -> Bool

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

(>) :: EventName -> EventName -> Bool

(>=) :: EventName -> EventName -> Bool

max :: EventName -> EventName -> EventName

min :: EventName -> EventName -> EventName

MsgpackDecode EventName

Defined in Ribosome.Host.Data.Event

Methods

fromMsgpack :: Object -> Either DecodeError EventName

MsgpackEncode EventName

Defined in Ribosome.Host.Data.Event

Methods

toMsgpack :: EventName -> Object

data Event

An event is an RPC notification sent by Neovim that is not intended to be dispatched to a named handler, but consumed in a broadcasting fashion.

Since they aren't marked as such, the host treats any notification with an unknown method name as an event.

Events can be consumed with Consume and subscribe.

Constructors

Event

Fields

• name :: EventName
• payload :: [Object]

Instances

Show Event

Defined in Ribosome.Host.Data.Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

Eq Event

Defined in Ribosome.Host.Data.Event

Methods

(==) :: Event -> Event -> Bool

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