Ribosome.Effect.VariableWatcher

An effect used internally to execute handlers when Neovim variables are changed.

Documentation

newtype WatchedVariable

The name of a variable that Ribosome should watch for changes.

Constructors

WatchedVariable

Fields

• unWatchedVariable :: Text

Instances

IsString WatchedVariable

Defined in Ribosome.Effect.VariableWatcher

Methods

fromString :: String -> WatchedVariable

Show WatchedVariable

Defined in Ribosome.Effect.VariableWatcher

Methods

showsPrec :: Int -> WatchedVariable -> ShowS

show :: WatchedVariable -> String

showList :: [WatchedVariable] -> ShowS

Eq WatchedVariable

Defined in Ribosome.Effect.VariableWatcher

Methods

(==) :: WatchedVariable -> WatchedVariable -> Bool

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

Ord WatchedVariable

Defined in Ribosome.Effect.VariableWatcher

Methods

compare :: WatchedVariable -> WatchedVariable -> Ordering

(<) :: WatchedVariable -> WatchedVariable -> Bool

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

(>) :: WatchedVariable -> WatchedVariable -> Bool

(>=) :: WatchedVariable -> WatchedVariable -> Bool

max :: WatchedVariable -> WatchedVariable -> WatchedVariable

min :: WatchedVariable -> WatchedVariable -> WatchedVariable

data VariableWatcher :: Effect where

An effect used internally to execute handlers when Neovim variables are changed.

Constructors

Update :: VariableWatcher m ()

Called when the internal logic determines that variables should be examined for updates.

Unwatch :: WatchedVariable -> VariableWatcher m ()

Stop running update handlers for the given variable.

update :: Member VariableWatcher r => Sem r ()

Called when the internal logic determines that variables should be examined for updates.

unwatch :: Member VariableWatcher r => WatchedVariable -> Sem r ()

Stop running update handlers for the given variable.