Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Synopsis
- sqidsVersion :: String
- defaultSqidsOptions :: SqidsOptions
- data SqidsOptions = SqidsOptions {}
- data SqidsError
- class Monad m => MonadSqids s m | m -> s
- sqidsContext :: (MonadSqids s m, MonadError SqidsError m) => SqidsOptions -> m (SqidsContext s)
- data SqidsT s m a
- runSqidsT :: (Integral s, Monad m) => SqidsOptions -> SqidsT s m a -> m (Either SqidsError a)
- sqidsT :: (Integral s, Monad m) => SqidsT s m a -> m (Either SqidsError a)
- type Sqids s = SqidsT s Identity
- runSqids :: Integral s => SqidsOptions -> Sqids s a -> Either SqidsError a
- sqids :: Integral s => Sqids s a -> Either SqidsError a
- encode :: MonadSqids Integer m => [Integer] -> m Text
- decode :: MonadSqids Integer m => Text -> m [Integer]
Documentation
sqidsVersion :: String Source #
Sqids spec. version
defaultSqidsOptions :: SqidsOptions Source #
Default options
data SqidsOptions Source #
Instances
Show SqidsOptions Source # | |
Defined in Web.Sqids.Internal showsPrec :: Int -> SqidsOptions -> ShowS # show :: SqidsOptions -> String # showList :: [SqidsOptions] -> ShowS # | |
Eq SqidsOptions Source # | |
Defined in Web.Sqids.Internal (==) :: SqidsOptions -> SqidsOptions -> Bool # (/=) :: SqidsOptions -> SqidsOptions -> Bool # | |
Ord SqidsOptions Source # | |
Defined in Web.Sqids.Internal compare :: SqidsOptions -> SqidsOptions -> Ordering # (<) :: SqidsOptions -> SqidsOptions -> Bool # (<=) :: SqidsOptions -> SqidsOptions -> Bool # (>) :: SqidsOptions -> SqidsOptions -> Bool # (>=) :: SqidsOptions -> SqidsOptions -> Bool # max :: SqidsOptions -> SqidsOptions -> SqidsOptions # min :: SqidsOptions -> SqidsOptions -> SqidsOptions # |
data SqidsError Source #
SqidsNegativeNumberInInput | One or more numbers in the list passed to |
SqidsMaxEncodingAttempts | Maximum allowed attemps was reached during encoding |
SqidsAlphabetContainsMultibyteCharacters | The alphabet cannot contain multi-byte characters. |
SqidsAlphabetTooShort | The alphabet must be at least 3 characters long. |
SqidsAlphabetRepeatedCharacters | The provided alphabet contains duplicate characters. E.g., "abcdefgg" is not a valid alphabet. |
SqidsInvalidMinLength | The given |
Instances
class Monad m => MonadSqids s m | m -> s Source #
Instances
sqidsContext :: (MonadSqids s m, MonadError SqidsError m) => SqidsOptions -> m (SqidsContext s) Source #
Sqids constructor
Sqids monad transformer
Instances
Monad m => MonadError SqidsError (SqidsT s m) Source # | |
Defined in Web.Sqids.Internal throwError :: SqidsError -> SqidsT s m a # catchError :: SqidsT s m a -> (SqidsError -> SqidsT s m a) -> SqidsT s m a # | |
(Integral s, Monad m) => MonadSqids s (SqidsT s m) Source # | |
Defined in Web.Sqids.Internal sqidsEncode :: [s] -> SqidsT s m Text Source # sqidsDecode :: Text -> SqidsT s m [s] Source # | |
MonadTrans (SqidsT s) Source # | |
Defined in Web.Sqids.Internal | |
Monad m => MonadReader (SqidsContext s) (SqidsT s m) Source # | |
Defined in Web.Sqids.Internal ask :: SqidsT s m (SqidsContext s) # local :: (SqidsContext s -> SqidsContext s) -> SqidsT s m a -> SqidsT s m a # reader :: (SqidsContext s -> a) -> SqidsT s m a # | |
MonadIO m => MonadIO (SqidsT s m) Source # | |
Defined in Web.Sqids.Internal | |
Monad m => Applicative (SqidsT s m) Source # | |
Defined in Web.Sqids.Internal | |
Functor m => Functor (SqidsT s m) Source # | |
Monad m => Monad (SqidsT s m) Source # | |
runSqidsT :: (Integral s, Monad m) => SqidsOptions -> SqidsT s m a -> m (Either SqidsError a) Source #
Evaluate a SqidsT
computation with the given options.
sqidsT :: (Integral s, Monad m) => SqidsT s m a -> m (Either SqidsError a) Source #
Evaluate a SqidsT
computation with the default options. This is a short
form for `runSqidsT defaultSqidsOptions`.
runSqids :: Integral s => SqidsOptions -> Sqids s a -> Either SqidsError a Source #
Evaluate a Sqids
computation with the given options.