Ribosome.Mapping

Functions for constructing and activating Mappings

Documentation

mappingCmdWith :: Member Rpc r => (Text -> Text -> Text -> Map Text Object -> RpcCall ()) -> Mapping -> Sem r ()

Generate an atomic call executing a mapping cmd for all modes specified in the Mapping and run it.

mappingCmd :: Member Rpc r => Mapping -> Sem r ()

Generate an atomic call executing a mapping cmd for all modes specified in the Mapping and run it.

bufferMappingCmd

Arguments

:: Member Rpc r

=> Buffer

Use buffer to create a buffer-local mapping.

-> Mapping

-> Sem r ()

Generate an atomic call executing a buffer mapping cmd for all modes specified in the Mapping and run it.

activateMapping :: Member Rpc r => Mapping -> Sem r ()

Register a mapping globally.

activateBufferMapping :: Member Rpc r => Buffer -> Mapping -> Sem r ()

Register a mapping in the supplied buffer.

mappingFor :: RpcHandler r -> MappingLhs -> NonEmpty MapMode -> Maybe MappingId -> Map Text Object -> Mapping

Construct a Mapping using the name from the supplied RpcHandler.

eventMapping :: EventName -> MappingLhs -> NonEmpty MapMode -> Maybe MappingId -> Map Text Object -> Mapping

Construct a Mapping using the supplied EventName.