ShortcutLinks

Documentation

data Result a

Resulting data type over the work of shortcut-links

Constructors

Failure String

Warning [String] a

Success a

Instances

Monad Result

Defined in ShortcutLinks.All

Methods

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

(>>) :: Result a -> Result b -> Result b

return :: a -> Result a

Functor Result

Defined in ShortcutLinks.All

Methods

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

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

MonadFail Result

Defined in ShortcutLinks.All

Methods

fail :: String -> Result a

Applicative Result

Defined in ShortcutLinks.All

Methods

pure :: a -> Result a

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

liftA2 :: (a -> b -> c) -> Result a -> Result b -> Result c

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

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

Show a => Show (Result a)

Defined in ShortcutLinks.All

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

type Shortcut = Maybe Text -> Text -> Result Text

Type alias for shortcut links Result functions.

allShortcuts :: [([Text], Shortcut)]

A list of all functions included in this module, together with suggested names for them.

useShortcut

Arguments

:: Text

Shortcut name

-> Maybe Text

Option

-> Text

Link text

-> Result Text

Resulting URL

Use a shortcut from allShortcuts.

This is the main function you should use.

useShortcutFrom

Arguments

:: [([Text], Shortcut)]

-> Text

Shortcut name

-> Maybe Text

Option

-> Text

Link text

-> Result Text

Resulting URL

Use a shortcut from a list.

For instance, if you want to add hk as a synonym for hackage, you'd write:

useShortcutFrom ((["hk"], hackage) : allShortcuts)