ribosome-host-0.9.9.9: Neovim plugin host for Polysemy
Safe HaskellSafe-Inferred
LanguageHaskell2010

Ribosome.Host.Data.RpcType

Synopsis

Documentation

newtype AutocmdEvents Source #

A set of autocmd event specifiers, like BufEnter, used to create and trigger autocmds.

Constructors

AutocmdEvents 

Fields

Instances

Instances details
IsString AutocmdEvents Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Generic AutocmdEvents Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Associated Types

type Rep AutocmdEvents :: Type -> Type #

Show AutocmdEvents Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Eq AutocmdEvents Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

MsgpackDecode AutocmdEvents Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

MsgpackEncode AutocmdEvents Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

type Rep AutocmdEvents Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

type Rep AutocmdEvents = D1 ('MetaData "AutocmdEvents" "Ribosome.Host.Data.RpcType" "ribosome-host-0.9.9.9-5mVeOZw909e7nfaEBEbC5r" 'True) (C1 ('MetaCons "AutocmdEvents" 'PrefixI 'True) (S1 ('MetaSel ('Just "unAutocmdEvent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

newtype AutocmdPatterns Source #

A file pattern like *.hs that defines the files in which an autocmd should be triggered.

If the AutocmdEvents contain User, this denotes the custom event name.

Constructors

AutocmdPatterns 

Fields

newtype AutocmdBuffer Source #

The buffer number in which a buffer autocmd is supposed to be created.

Constructors

AutocmdBuffer 

Fields

Instances

Instances details
Enum AutocmdBuffer Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Num AutocmdBuffer Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Integral AutocmdBuffer Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Real AutocmdBuffer Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Show AutocmdBuffer Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Eq AutocmdBuffer Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Ord AutocmdBuffer Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

MsgpackDecode AutocmdBuffer Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

MsgpackEncode AutocmdBuffer Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

data AutocmdOptions Source #

The options with which an autocmd may be defined.

See :help :autocmd.

Instances

Instances details
IsString AutocmdOptions Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Generic AutocmdOptions Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Associated Types

type Rep AutocmdOptions :: Type -> Type #

Show AutocmdOptions Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Default AutocmdOptions Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Methods

def :: AutocmdOptions #

Eq AutocmdOptions Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

type Rep AutocmdOptions Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

type Rep AutocmdOptions = D1 ('MetaData "AutocmdOptions" "Ribosome.Host.Data.RpcType" "ribosome-host-0.9.9.9-5mVeOZw909e7nfaEBEbC5r" 'False) (C1 ('MetaCons "AutocmdOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either AutocmdBuffer AutocmdPatterns)) :*: S1 ('MetaSel ('Just "nested") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "once") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "group") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AutocmdGroup)))))

newtype AutocmdId Source #

Neovim assigns ID numbers to autocmds.

Constructors

AutocmdId 

Fields

Instances

Instances details
Enum AutocmdId Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Num AutocmdId Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Integral AutocmdId Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Real AutocmdId Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Show AutocmdId Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Eq AutocmdId Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Ord AutocmdId Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

MsgpackDecode AutocmdId Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

MsgpackEncode AutocmdId Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

data CompleteStyle Source #

Neovim command completion can be designated as returning all items that may be completed regardless of the current word (CompleteUnfiltered) or only those that match the current word (CompleteFiltered).

Constructors

CompleteFiltered

Completion returns matching items.

CompleteUnfiltered

Completion returns all items.

Instances

Instances details
Show CompleteStyle Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Eq CompleteStyle Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

data CommandCompletion Source #

The completion to use for a command.

Constructors

CompleteBuiltin Text

Complete with one of the builtin completions, see :help :command-completion.

CompleteHandler CompleteStyle RpcName

Complete with an RPC handler defined by a plugin.

completionName :: RpcName -> RpcName Source #

Generate a name for the completion handler of a handler by prefixing its name with Complete_.

completionValue :: CommandCompletion -> Text Source #

Render a CommandCompletion as the value to the -complete= option for a command definition.

completionOption :: CommandCompletion -> Text Source #

Render a CommandCompletion as the -complete= option for a command definition.

data CommandOptions Source #

Options for an RPC command on the Neovim side, consisting of the options described at :help :command-attributes and an optional completion handler.

Instances

Instances details
Show CommandOptions Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

newtype CommandArgs Source #

The special arguments passed to an RPC call on the Neovim side that correspond to the declared CommandOptions.

Constructors

CommandArgs 

Fields

Instances

Instances details
Show CommandArgs Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Eq CommandArgs Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

data RpcType Source #

The type of RPC handler and its options.

Instances

Instances details
Generic RpcType Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

Associated Types

type Rep RpcType :: Type -> Type #

Methods

from :: RpcType -> Rep RpcType x #

to :: Rep RpcType x -> RpcType #

Show RpcType Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

type Rep RpcType Source # 
Instance details

Defined in Ribosome.Host.Data.RpcType

methodPrefix :: RpcType -> Text Source #

The prefix for the method name used to identify an RPC handler.