Safe Haskell	Safe-Inferred
Language	Haskell2010

Ribosome.Host.Data.Request

Synopsis

newtype RpcMethod = RpcMethod {
- unRpcMethod :: Text
}
newtype RequestId = RequestId {
- unRequestId :: Int64
}
data Request = Request {
- method :: RpcMethod
- arguments :: [Object]
}
data TrackedRequest = TrackedRequest {
- id :: RequestId
- request :: Request
}
formatReq :: Request -> Text
formatTrackedReq :: TrackedRequest -> Text

Documentation

newtype RpcMethod Source #

Constructors

RpcMethod
Fields unRpcMethod :: Text

Instances

Instances details

IsString RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Methods fromString :: String -> RpcMethod #
Monoid RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Methods mempty :: RpcMethod # mappend :: RpcMethod -> RpcMethod -> RpcMethod # mconcat :: [RpcMethod] -> RpcMethod #
Semigroup RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Methods (<>) :: RpcMethod -> RpcMethod -> RpcMethod # sconcat :: NonEmpty RpcMethod -> RpcMethod # stimes :: Integral b => b -> RpcMethod -> RpcMethod #
Generic RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Associated Types type Rep RpcMethod :: Type -> Type # Methods from :: RpcMethod -> Rep RpcMethod x # to :: Rep RpcMethod x -> RpcMethod #
Show RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Methods showsPrec :: Int -> RpcMethod -> ShowS # show :: RpcMethod -> String # showList :: [RpcMethod] -> ShowS #
Eq RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Methods (==) :: RpcMethod -> RpcMethod -> Bool # (/=) :: RpcMethod -> RpcMethod -> Bool #
Ord RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Methods compare :: RpcMethod -> RpcMethod -> Ordering # (<) :: RpcMethod -> RpcMethod -> Bool # (<=) :: RpcMethod -> RpcMethod -> Bool # (>) :: RpcMethod -> RpcMethod -> Bool # (>=) :: RpcMethod -> RpcMethod -> Bool # max :: RpcMethod -> RpcMethod -> RpcMethod # min :: RpcMethod -> RpcMethod -> RpcMethod #
MsgpackDecode RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Methods fromMsgpack :: Object -> Either Text RpcMethod Source # missingKey :: String -> Object -> Either Text RpcMethod Source #
MsgpackEncode RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request Methods toMsgpack :: RpcMethod -> Object Source #
type Rep RpcMethod Source #
Instance details Defined in Ribosome.Host.Data.Request type Rep RpcMethod = D1 ('MetaData "RpcMethod" "Ribosome.Host.Data.Request" "ribosome-host-0.9.9.9-5mVeOZw909e7nfaEBEbC5r" 'True) (C1 ('MetaCons "RpcMethod" 'PrefixI 'True) (S1 ('MetaSel ('Just "unRpcMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype RequestId Source #

Constructors

RequestId
Fields unRequestId :: Int64

Instances

Instances details

Enum RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods succ :: RequestId -> RequestId # pred :: RequestId -> RequestId # toEnum :: Int -> RequestId # fromEnum :: RequestId -> Int # enumFrom :: RequestId -> [RequestId] # enumFromThen :: RequestId -> RequestId -> [RequestId] # enumFromTo :: RequestId -> RequestId -> [RequestId] # enumFromThenTo :: RequestId -> RequestId -> RequestId -> [RequestId] #
Generic RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Associated Types type Rep RequestId :: Type -> Type # Methods from :: RequestId -> Rep RequestId x # to :: Rep RequestId x -> RequestId #
Num RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods (+) :: RequestId -> RequestId -> RequestId # (-) :: RequestId -> RequestId -> RequestId # (*) :: RequestId -> RequestId -> RequestId # negate :: RequestId -> RequestId # abs :: RequestId -> RequestId # signum :: RequestId -> RequestId # fromInteger :: Integer -> RequestId #
Integral RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods quot :: RequestId -> RequestId -> RequestId # rem :: RequestId -> RequestId -> RequestId # div :: RequestId -> RequestId -> RequestId # mod :: RequestId -> RequestId -> RequestId # quotRem :: RequestId -> RequestId -> (RequestId, RequestId) # divMod :: RequestId -> RequestId -> (RequestId, RequestId) # toInteger :: RequestId -> Integer #
Real RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods toRational :: RequestId -> Rational #
Show RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods showsPrec :: Int -> RequestId -> ShowS # show :: RequestId -> String # showList :: [RequestId] -> ShowS #
Eq RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods (==) :: RequestId -> RequestId -> Bool # (/=) :: RequestId -> RequestId -> Bool #
Ord RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods compare :: RequestId -> RequestId -> Ordering # (<) :: RequestId -> RequestId -> Bool # (<=) :: RequestId -> RequestId -> Bool # (>) :: RequestId -> RequestId -> Bool # (>=) :: RequestId -> RequestId -> Bool # max :: RequestId -> RequestId -> RequestId # min :: RequestId -> RequestId -> RequestId #
MsgpackDecode RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods fromMsgpack :: Object -> Either Text RequestId Source # missingKey :: String -> Object -> Either Text RequestId Source #
MsgpackEncode RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request Methods toMsgpack :: RequestId -> Object Source #
type Rep RequestId Source #
Instance details Defined in Ribosome.Host.Data.Request type Rep RequestId = D1 ('MetaData "RequestId" "Ribosome.Host.Data.Request" "ribosome-host-0.9.9.9-5mVeOZw909e7nfaEBEbC5r" 'True) (C1 ('MetaCons "RequestId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

data Request Source #

The payload of an RPC request.

Constructors

Request
Fields method :: RpcMethod The method, which is either the Neovim API function name or the internal identifier of a Ribosome handler. arguments :: [Object] The arguments.

Instances

Instances details

Generic Request Source #
Instance details Defined in Ribosome.Host.Data.Request Associated Types type Rep Request :: Type -> Type # Methods from :: Request -> Rep Request x # to :: Rep Request x -> Request #
Show Request Source #
Instance details Defined in Ribosome.Host.Data.Request Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #
Eq Request Source #
Instance details Defined in Ribosome.Host.Data.Request Methods (==) :: Request -> Request -> Bool # (/=) :: Request -> Request -> Bool #
MsgpackEncode Request Source #
Instance details Defined in Ribosome.Host.Data.Request Methods toMsgpack :: Request -> Object Source #
type Rep Request Source #
Instance details Defined in Ribosome.Host.Data.Request type Rep Request = D1 ('MetaData "Request" "Ribosome.Host.Data.Request" "ribosome-host-0.9.9.9-5mVeOZw909e7nfaEBEbC5r" 'False) (C1 ('MetaCons "Request" 'PrefixI 'True) (S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RpcMethod) :*: S1 ('MetaSel ('Just "arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Object])))

data TrackedRequest Source #

An RPC request, which is a payload combined with a request ID.

Constructors

TrackedRequest
Fields id :: RequestId The ID is used to associate the response with the sender. request :: Request The payload.

Instances

Instances details

Show TrackedRequest Source #
Instance details Defined in Ribosome.Host.Data.Request Methods showsPrec :: Int -> TrackedRequest -> ShowS # show :: TrackedRequest -> String # showList :: [TrackedRequest] -> ShowS #
Eq TrackedRequest Source #
Instance details Defined in Ribosome.Host.Data.Request Methods (==) :: TrackedRequest -> TrackedRequest -> Bool # (/=) :: TrackedRequest -> TrackedRequest -> Bool #

formatReq :: Request -> Text Source #

formatTrackedReq :: TrackedRequest -> Text Source #