Rasa.Internal.BufAction

Documentation

newtype BufAction a

This is a monad for performing actions on a specific buffer. You run BufActions by embedding them in a Action via bufferDo or buffersDo

Within a BufAction you can:

• Use liftAction to run an Action
• Use liftIO for IO
• Access/Edit the buffer's text; some commands are available in Rasa.Internal.Actions.
• Access/edit buffer extensions; see bufExt
• Embed and sequence BufActions from other extensions

Constructors

BufAction

Fields

• getBufAction :: Free (BufActionF BufActionState) a

Instances

Monad BufAction

Methods

(>>=) :: BufAction a -> (a -> BufAction b) -> BufAction b

(>>) :: BufAction a -> BufAction b -> BufAction b

return :: a -> BufAction a

fail :: String -> BufAction a

Functor BufAction

Methods

fmap :: (a -> b) -> BufAction a -> BufAction b

(<$) :: a -> BufAction b -> BufAction a

Applicative BufAction

Methods

pure :: a -> BufAction a

(<*>) :: BufAction (a -> b) -> BufAction a -> BufAction b

(*>) :: BufAction a -> BufAction b -> BufAction b

(<*) :: BufAction a -> BufAction b -> BufAction a

MonadIO BufAction

Methods

liftIO :: IO a -> BufAction a

getText :: BufAction YiString

Returns the text of the current buffer

setText :: YiString -> BufAction ()

Sets the text of the current buffer

getRange :: CrdRange -> BufAction YiString

Gets the range of text from the buffer

setRange :: CrdRange -> YiString -> BufAction ()

Sets the range of text from the buffer

liftState :: (BufActionState -> (a, BufActionState)) -> BufAction a

Allows running state actions over BufActionState; used to lift mtl state functions

liftAction :: Action r -> BufAction r

This lifts up an Action to be run inside a BufAction

runBufAction :: BufAction a -> BufRef -> Action (Maybe a)

This lifts up a bufAction into an Action which performs the BufAction over the referenced buffer and returns the result (if the buffer existed)