Neovim.Classes

Documentation

class NvimObject o where

Conversion from Object files to Haskell types and back with respect to neovim's interpretation.

Minimal complete definition

toObject

Methods

toObject :: o -> Object

fromObjectUnsafe :: Object -> o

fromObject :: Object -> Either Doc o

Instances

NvimObject Bool

Methods

toObject :: Bool -> Object

fromObjectUnsafe :: Object -> Bool

fromObject :: Object -> Either Doc Bool

NvimObject Char

Methods

toObject :: Char -> Object

fromObjectUnsafe :: Object -> Char

fromObject :: Object -> Either Doc Char

NvimObject Double

Methods

toObject :: Double -> Object

fromObjectUnsafe :: Object -> Double

fromObject :: Object -> Either Doc Double

NvimObject Int

Methods

toObject :: Int -> Object

fromObjectUnsafe :: Object -> Int

fromObject :: Object -> Either Doc Int

NvimObject Int8

Methods

toObject :: Int8 -> Object

fromObjectUnsafe :: Object -> Int8

fromObject :: Object -> Either Doc Int8

NvimObject Int16

Methods

toObject :: Int16 -> Object

fromObjectUnsafe :: Object -> Int16

fromObject :: Object -> Either Doc Int16

NvimObject Int32

Methods

toObject :: Int32 -> Object

fromObjectUnsafe :: Object -> Int32

fromObject :: Object -> Either Doc Int32

NvimObject Int64

Methods

toObject :: Int64 -> Object

fromObjectUnsafe :: Object -> Int64

fromObject :: Object -> Either Doc Int64

NvimObject Integer

Methods

toObject :: Integer -> Object

fromObjectUnsafe :: Object -> Integer

fromObject :: Object -> Either Doc Integer

NvimObject Word

Methods

toObject :: Word -> Object

fromObjectUnsafe :: Object -> Word

fromObject :: Object -> Either Doc Word

NvimObject Word8

Methods

toObject :: Word8 -> Object

fromObjectUnsafe :: Object -> Word8

fromObject :: Object -> Either Doc Word8

NvimObject Word16

Methods

toObject :: Word16 -> Object

fromObjectUnsafe :: Object -> Word16

fromObject :: Object -> Either Doc Word16

NvimObject Word32

Methods

toObject :: Word32 -> Object

fromObjectUnsafe :: Object -> Word32

fromObject :: Object -> Either Doc Word32

NvimObject Word64

Methods

toObject :: Word64 -> Object

fromObjectUnsafe :: Object -> Word64

fromObject :: Object -> Either Doc Word64

NvimObject ()

Methods

toObject :: () -> Object

fromObjectUnsafe :: Object -> ()

fromObject :: Object -> Either Doc ()

NvimObject Doc

Methods

toObject :: Doc -> Object

fromObjectUnsafe :: Object -> Doc

fromObject :: Object -> Either Doc Doc

NvimObject ByteString

Methods

toObject :: ByteString -> Object

fromObjectUnsafe :: Object -> ByteString

fromObject :: Object -> Either Doc ByteString

NvimObject Text

Methods

toObject :: Text -> Object

fromObjectUnsafe :: Object -> Text

fromObject :: Object -> Either Doc Text

NvimObject Object

Methods

toObject :: Object -> Object

fromObjectUnsafe :: Object -> Object

fromObject :: Object -> Either Doc Object

NvimObject AutocmdOptions

Methods

toObject :: AutocmdOptions -> Object

fromObjectUnsafe :: Object -> AutocmdOptions

fromObject :: Object -> Either Doc AutocmdOptions

NvimObject CommandArguments

Methods

toObject :: CommandArguments -> Object

fromObjectUnsafe :: Object -> CommandArguments

fromObject :: Object -> Either Doc CommandArguments

NvimObject RangeSpecification

Methods

toObject :: RangeSpecification -> Object

fromObjectUnsafe :: Object -> RangeSpecification

fromObject :: Object -> Either Doc RangeSpecification

NvimObject CommandOptions

Methods

toObject :: CommandOptions -> Object

fromObjectUnsafe :: Object -> CommandOptions

fromObject :: Object -> Either Doc CommandOptions

NvimObject Synchronous

Methods

toObject :: Synchronous -> Object

fromObjectUnsafe :: Object -> Synchronous

fromObject :: Object -> Either Doc Synchronous

NvimObject Message

Methods

toObject :: Message -> Object

fromObjectUnsafe :: Object -> Message

fromObject :: Object -> Either Doc Message

NvimObject Window

Methods

toObject :: Window -> Object

fromObjectUnsafe :: Object -> Window

fromObject :: Object -> Either Doc Window

NvimObject Tabpage

Methods

toObject :: Tabpage -> Object

fromObjectUnsafe :: Object -> Tabpage

fromObject :: Object -> Either Doc Tabpage

NvimObject Buffer

Methods

toObject :: Buffer -> Object

fromObjectUnsafe :: Object -> Buffer

fromObject :: Object -> Either Doc Buffer

NvimObject NeovimExceptionGen

Methods

toObject :: NeovimExceptionGen -> Object

fromObjectUnsafe :: Object -> NeovimExceptionGen

fromObject :: Object -> Either Doc NeovimExceptionGen

NvimObject QuickfixAction

Methods

toObject :: QuickfixAction -> Object

fromObjectUnsafe :: Object -> QuickfixAction

fromObject :: Object -> Either Doc QuickfixAction

NvimObject QuickfixErrorType

Methods

toObject :: QuickfixErrorType -> Object

fromObjectUnsafe :: Object -> QuickfixErrorType

fromObject :: Object -> Either Doc QuickfixErrorType

NvimObject [Char]

Methods

toObject :: [Char] -> Object

fromObjectUnsafe :: Object -> [Char]

fromObject :: Object -> Either Doc [Char]

NvimObject o => NvimObject [o]

Methods

toObject :: [o] -> Object

fromObjectUnsafe :: Object -> [o]

fromObject :: Object -> Either Doc [o]

NvimObject o => NvimObject (Maybe o)

Methods

toObject :: Maybe o -> Object

fromObjectUnsafe :: Object -> Maybe o

fromObject :: Object -> Either Doc (Maybe o)

(Monoid strType, NvimObject strType) => NvimObject (QuickfixListItem strType)

Methods

toObject :: QuickfixListItem strType -> Object

fromObjectUnsafe :: Object -> QuickfixListItem strType

fromObject :: Object -> Either Doc (QuickfixListItem strType)

(NvimObject l, NvimObject r) => NvimObject (Either l r)

Right-biased instance for toObject.

Methods

toObject :: Either l r -> Object

fromObjectUnsafe :: Object -> Either l r

fromObject :: Object -> Either Doc (Either l r)

(NvimObject o1, NvimObject o2) => NvimObject (o1, o2)

Methods

toObject :: (o1, o2) -> Object

fromObjectUnsafe :: Object -> (o1, o2)

fromObject :: Object -> Either Doc (o1, o2)

(Ord key, NvimObject key, NvimObject val) => NvimObject (Map key val)

Methods

toObject :: Map key val -> Object

fromObjectUnsafe :: Object -> Map key val

fromObject :: Object -> Either Doc (Map key val)

(NvimObject o1, NvimObject o2, NvimObject o3) => NvimObject (o1, o2, o3)

Methods

toObject :: (o1, o2, o3) -> Object

fromObjectUnsafe :: Object -> (o1, o2, o3)

fromObject :: Object -> Either Doc (o1, o2, o3)

(NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4) => NvimObject (o1, o2, o3, o4)

Methods

toObject :: (o1, o2, o3, o4) -> Object

fromObjectUnsafe :: Object -> (o1, o2, o3, o4)

fromObject :: Object -> Either Doc (o1, o2, o3, o4)

(NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5) => NvimObject (o1, o2, o3, o4, o5)

Methods

toObject :: (o1, o2, o3, o4, o5) -> Object

fromObjectUnsafe :: Object -> (o1, o2, o3, o4, o5)

fromObject :: Object -> Either Doc (o1, o2, o3, o4, o5)

(NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5, NvimObject o6) => NvimObject (o1, o2, o3, o4, o5, o6)

Methods

toObject :: (o1, o2, o3, o4, o5, o6) -> Object

fromObjectUnsafe :: Object -> (o1, o2, o3, o4, o5, o6)

fromObject :: Object -> Either Doc (o1, o2, o3, o4, o5, o6)

(NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5, NvimObject o6, NvimObject o7) => NvimObject (o1, o2, o3, o4, o5, o6, o7)

Methods

toObject :: (o1, o2, o3, o4, o5, o6, o7) -> Object

fromObjectUnsafe :: Object -> (o1, o2, o3, o4, o5, o6, o7)

fromObject :: Object -> Either Doc (o1, o2, o3, o4, o5, o6, o7)

(NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5, NvimObject o6, NvimObject o7, NvimObject o8) => NvimObject (o1, o2, o3, o4, o5, o6, o7, o8)

Methods

toObject :: (o1, o2, o3, o4, o5, o6, o7, o8) -> Object

fromObjectUnsafe :: Object -> (o1, o2, o3, o4, o5, o6, o7, o8)

fromObject :: Object -> Either Doc (o1, o2, o3, o4, o5, o6, o7, o8)

(NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5, NvimObject o6, NvimObject o7, NvimObject o8, NvimObject o9) => NvimObject (o1, o2, o3, o4, o5, o6, o7, o8, o9)

Methods

toObject :: (o1, o2, o3, o4, o5, o6, o7, o8, o9) -> Object

fromObjectUnsafe :: Object -> (o1, o2, o3, o4, o5, o6, o7, o8, o9)

fromObject :: Object -> Either Doc (o1, o2, o3, o4, o5, o6, o7, o8, o9)

type Dictionary = Map ByteString Object

A generic vim dictionary is a simply a map from strings to objects. This type alias is sometimes useful as a type annotation especially if the OverloadedStrings extension is enabled.

(+:) :: NvimObject o => o -> [Object] -> [Object] infixr 5

Convenient operator to create a list of Object from normal values.

module Data.Int

module Data.Word