Ribosome.Host.Data.RpcType

Documentation

newtype AutocmdEvents

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

Constructors

AutocmdEvents

Fields

• unAutocmdEvent :: [Text]

Instances

IsString AutocmdEvents

Defined in Ribosome.Host.Data.RpcType

Methods

fromString :: String -> AutocmdEvents

Generic AutocmdEvents

Defined in Ribosome.Host.Data.RpcType

Associated Types

type Rep AutocmdEvents :: Type -> Type

Methods

from :: AutocmdEvents -> Rep AutocmdEvents x

to :: Rep AutocmdEvents x -> AutocmdEvents

Show AutocmdEvents

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> AutocmdEvents -> ShowS

show :: AutocmdEvents -> String

showList :: [AutocmdEvents] -> ShowS

Eq AutocmdEvents

Defined in Ribosome.Host.Data.RpcType

Methods

(==) :: AutocmdEvents -> AutocmdEvents -> Bool

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

MsgpackDecode AutocmdEvents

Defined in Ribosome.Host.Data.RpcType

Methods

fromMsgpack :: Object -> Either Text AutocmdEvents

missingKey :: String -> Object -> Either Text AutocmdEvents

MsgpackEncode AutocmdEvents

Defined in Ribosome.Host.Data.RpcType

Methods

toMsgpack :: AutocmdEvents -> Object

type Rep AutocmdEvents

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

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

• unAutocmdPattern :: [Text]

Instances

IsString AutocmdPatterns

Defined in Ribosome.Host.Data.RpcType

Methods

fromString :: String -> AutocmdPatterns

Show AutocmdPatterns

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> AutocmdPatterns -> ShowS

show :: AutocmdPatterns -> String

showList :: [AutocmdPatterns] -> ShowS

Default AutocmdPatterns

Defined in Ribosome.Host.Data.RpcType

Methods

def :: AutocmdPatterns

Eq AutocmdPatterns

Defined in Ribosome.Host.Data.RpcType

Methods

(==) :: AutocmdPatterns -> AutocmdPatterns -> Bool

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

MsgpackDecode AutocmdPatterns

Defined in Ribosome.Host.Data.RpcType

Methods

fromMsgpack :: Object -> Either Text AutocmdPatterns

missingKey :: String -> Object -> Either Text AutocmdPatterns

MsgpackEncode AutocmdPatterns

Defined in Ribosome.Host.Data.RpcType

Methods

toMsgpack :: AutocmdPatterns -> Object

newtype AutocmdBuffer

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

Constructors

AutocmdBuffer

Fields

• unAutocmdBuffer :: Int

Instances

Enum AutocmdBuffer

Defined in Ribosome.Host.Data.RpcType

Methods

succ :: AutocmdBuffer -> AutocmdBuffer

pred :: AutocmdBuffer -> AutocmdBuffer

toEnum :: Int -> AutocmdBuffer

fromEnum :: AutocmdBuffer -> Int

enumFrom :: AutocmdBuffer -> [AutocmdBuffer]

enumFromThen :: AutocmdBuffer -> AutocmdBuffer -> [AutocmdBuffer]

enumFromTo :: AutocmdBuffer -> AutocmdBuffer -> [AutocmdBuffer]

enumFromThenTo :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer -> [AutocmdBuffer]

Num AutocmdBuffer

Defined in Ribosome.Host.Data.RpcType

Methods

(+) :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer

(-) :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer

(*) :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer

negate :: AutocmdBuffer -> AutocmdBuffer

abs :: AutocmdBuffer -> AutocmdBuffer

signum :: AutocmdBuffer -> AutocmdBuffer

fromInteger :: Integer -> AutocmdBuffer

Integral AutocmdBuffer

Defined in Ribosome.Host.Data.RpcType

Methods

quot :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer

rem :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer

div :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer

mod :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer

quotRem :: AutocmdBuffer -> AutocmdBuffer -> (AutocmdBuffer, AutocmdBuffer)

divMod :: AutocmdBuffer -> AutocmdBuffer -> (AutocmdBuffer, AutocmdBuffer)

toInteger :: AutocmdBuffer -> Integer

Real AutocmdBuffer

Defined in Ribosome.Host.Data.RpcType

Methods

toRational :: AutocmdBuffer -> Rational

Show AutocmdBuffer

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> AutocmdBuffer -> ShowS

show :: AutocmdBuffer -> String

showList :: [AutocmdBuffer] -> ShowS

Eq AutocmdBuffer

Defined in Ribosome.Host.Data.RpcType

Methods

(==) :: AutocmdBuffer -> AutocmdBuffer -> Bool

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

Ord AutocmdBuffer

Defined in Ribosome.Host.Data.RpcType

Methods

compare :: AutocmdBuffer -> AutocmdBuffer -> Ordering

(<) :: AutocmdBuffer -> AutocmdBuffer -> Bool

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

(>) :: AutocmdBuffer -> AutocmdBuffer -> Bool

(>=) :: AutocmdBuffer -> AutocmdBuffer -> Bool

max :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer

min :: AutocmdBuffer -> AutocmdBuffer -> AutocmdBuffer

MsgpackDecode AutocmdBuffer

Defined in Ribosome.Host.Data.RpcType

Methods

fromMsgpack :: Object -> Either Text AutocmdBuffer

missingKey :: String -> Object -> Either Text AutocmdBuffer

MsgpackEncode AutocmdBuffer

Defined in Ribosome.Host.Data.RpcType

Methods

toMsgpack :: AutocmdBuffer -> Object

newtype AutocmdGroup

An autocmd group.

Constructors

AutocmdGroup

Fields

• unAutocmdGroup :: Text

Instances

IsString AutocmdGroup

Defined in Ribosome.Host.Data.RpcType

Methods

fromString :: String -> AutocmdGroup

Show AutocmdGroup

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> AutocmdGroup -> ShowS

show :: AutocmdGroup -> String

showList :: [AutocmdGroup] -> ShowS

Eq AutocmdGroup

Defined in Ribosome.Host.Data.RpcType

Methods

(==) :: AutocmdGroup -> AutocmdGroup -> Bool

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

Ord AutocmdGroup

Defined in Ribosome.Host.Data.RpcType

Methods

compare :: AutocmdGroup -> AutocmdGroup -> Ordering

(<) :: AutocmdGroup -> AutocmdGroup -> Bool

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

(>) :: AutocmdGroup -> AutocmdGroup -> Bool

(>=) :: AutocmdGroup -> AutocmdGroup -> Bool

max :: AutocmdGroup -> AutocmdGroup -> AutocmdGroup

min :: AutocmdGroup -> AutocmdGroup -> AutocmdGroup

MsgpackDecode AutocmdGroup

Defined in Ribosome.Host.Data.RpcType

Methods

fromMsgpack :: Object -> Either Text AutocmdGroup

missingKey :: String -> Object -> Either Text AutocmdGroup

MsgpackEncode AutocmdGroup

Defined in Ribosome.Host.Data.RpcType

Methods

toMsgpack :: AutocmdGroup -> Object

data AutocmdOptions

The options with which an autocmd may be defined.

See :help :autocmd.

Constructors

AutocmdOptions

Fields

• target :: Either AutocmdBuffer AutocmdPatterns
• nested :: Bool
• once :: Bool
• group :: Maybe AutocmdGroup

Instances

IsString AutocmdOptions

Defined in Ribosome.Host.Data.RpcType

Methods

fromString :: String -> AutocmdOptions

Generic AutocmdOptions

Defined in Ribosome.Host.Data.RpcType

Associated Types

type Rep AutocmdOptions :: Type -> Type

Methods

from :: AutocmdOptions -> Rep AutocmdOptions x

to :: Rep AutocmdOptions x -> AutocmdOptions

Show AutocmdOptions

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> AutocmdOptions -> ShowS

show :: AutocmdOptions -> String

showList :: [AutocmdOptions] -> ShowS

Default AutocmdOptions

Defined in Ribosome.Host.Data.RpcType

Methods

def :: AutocmdOptions

Eq AutocmdOptions

Defined in Ribosome.Host.Data.RpcType

Methods

(==) :: AutocmdOptions -> AutocmdOptions -> Bool

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

type Rep AutocmdOptions

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

Neovim assigns ID numbers to autocmds.

Constructors

AutocmdId

Fields

• unAutocmdId :: Int

Instances

Enum AutocmdId

Defined in Ribosome.Host.Data.RpcType

Methods

succ :: AutocmdId -> AutocmdId

pred :: AutocmdId -> AutocmdId

toEnum :: Int -> AutocmdId

fromEnum :: AutocmdId -> Int

enumFrom :: AutocmdId -> [AutocmdId]

enumFromThen :: AutocmdId -> AutocmdId -> [AutocmdId]

enumFromTo :: AutocmdId -> AutocmdId -> [AutocmdId]

enumFromThenTo :: AutocmdId -> AutocmdId -> AutocmdId -> [AutocmdId]

Num AutocmdId

Defined in Ribosome.Host.Data.RpcType

Methods

(+) :: AutocmdId -> AutocmdId -> AutocmdId

(-) :: AutocmdId -> AutocmdId -> AutocmdId

(*) :: AutocmdId -> AutocmdId -> AutocmdId

negate :: AutocmdId -> AutocmdId

abs :: AutocmdId -> AutocmdId

signum :: AutocmdId -> AutocmdId

fromInteger :: Integer -> AutocmdId

Integral AutocmdId

Defined in Ribosome.Host.Data.RpcType

Methods

quot :: AutocmdId -> AutocmdId -> AutocmdId

rem :: AutocmdId -> AutocmdId -> AutocmdId

div :: AutocmdId -> AutocmdId -> AutocmdId

mod :: AutocmdId -> AutocmdId -> AutocmdId

quotRem :: AutocmdId -> AutocmdId -> (AutocmdId, AutocmdId)

divMod :: AutocmdId -> AutocmdId -> (AutocmdId, AutocmdId)

toInteger :: AutocmdId -> Integer

Real AutocmdId

Defined in Ribosome.Host.Data.RpcType

Methods

toRational :: AutocmdId -> Rational

Show AutocmdId

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> AutocmdId -> ShowS

show :: AutocmdId -> String

showList :: [AutocmdId] -> ShowS

Eq AutocmdId

Defined in Ribosome.Host.Data.RpcType

Methods

(==) :: AutocmdId -> AutocmdId -> Bool

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

Ord AutocmdId

Defined in Ribosome.Host.Data.RpcType

Methods

compare :: AutocmdId -> AutocmdId -> Ordering

(<) :: AutocmdId -> AutocmdId -> Bool

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

(>) :: AutocmdId -> AutocmdId -> Bool

(>=) :: AutocmdId -> AutocmdId -> Bool

max :: AutocmdId -> AutocmdId -> AutocmdId

min :: AutocmdId -> AutocmdId -> AutocmdId

MsgpackDecode AutocmdId

Defined in Ribosome.Host.Data.RpcType

Methods

fromMsgpack :: Object -> Either Text AutocmdId

missingKey :: String -> Object -> Either Text AutocmdId

MsgpackEncode AutocmdId

Defined in Ribosome.Host.Data.RpcType

Methods

toMsgpack :: AutocmdId -> Object

data CompleteStyle

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

Show CompleteStyle

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> CompleteStyle -> ShowS

show :: CompleteStyle -> String

showList :: [CompleteStyle] -> ShowS

Eq CompleteStyle

Defined in Ribosome.Host.Data.RpcType

Methods

(==) :: CompleteStyle -> CompleteStyle -> Bool

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

data CommandCompletion

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.

Instances

Show CommandCompletion

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> CommandCompletion -> ShowS

show :: CommandCompletion -> String

showList :: [CommandCompletion] -> ShowS

Eq CommandCompletion

Defined in Ribosome.Host.Data.RpcType

Methods

(==) :: CommandCompletion -> CommandCompletion -> Bool

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

completionName :: RpcName -> RpcName

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

completionValue :: CommandCompletion -> Text

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

completionOption :: CommandCompletion -> Text

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

data CommandOptions

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

Constructors

CommandOptions

Fields

• basic :: Map Text Object
• completion :: Maybe CommandCompletion

Instances

Show CommandOptions

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> CommandOptions -> ShowS

show :: CommandOptions -> String

showList :: [CommandOptions] -> ShowS

newtype CommandArgs

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

Constructors

CommandArgs

Fields

• unCommandArgs :: [Text]

Instances

Show CommandArgs

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> CommandArgs -> ShowS

show :: CommandArgs -> String

showList :: [CommandArgs] -> ShowS

Eq CommandArgs

Defined in Ribosome.Host.Data.RpcType

Methods

(==) :: CommandArgs -> CommandArgs -> Bool

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

data RpcType

The type of RPC handler and its options.

Constructors

Function

Command CommandOptions CommandArgs

Autocmd AutocmdEvents AutocmdOptions

Instances

Generic RpcType

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

Defined in Ribosome.Host.Data.RpcType

Methods

showsPrec :: Int -> RpcType -> ShowS

show :: RpcType -> String

showList :: [RpcType] -> ShowS

type Rep RpcType

Defined in Ribosome.Host.Data.RpcType

type Rep RpcType = D1 ('MetaData "RpcType" "Ribosome.Host.Data.RpcType" "ribosome-host-0.9.9.9-5mVeOZw909e7nfaEBEbC5r" 'False) (C1 ('MetaCons "Function" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Command" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommandOptions) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommandArgs)) :+: C1 ('MetaCons "Autocmd" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AutocmdEvents) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AutocmdOptions))))

methodPrefix :: RpcType -> Text

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