Copyright	(c) 2023 Keito Kajitani
License	MIT
Maintainer	Keito Kajitani <ijaketak@gmail.com>
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Ulid

Description

This module exposes the data type Ulid and related functions. The data type Ulid consumes only 128-bit.

Synopsis

data Ulid
nil :: Ulid
getUlid :: (MonadIO m, StatefulGen g m) => g -> m Ulid
randomUlidM :: StatefulGen g m => POSIXTime -> g -> m Ulid
genUlid :: RandomGen g => POSIXTime -> g -> (Ulid, g)
showUlid :: Ulid -> Text
readUlid :: Text -> Maybe Ulid

Documentation

data Ulid Source #

Instances

Instances details

Data Ulid Source #
Instance details Defined in Data.Ulid Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Ulid -> c Ulid # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Ulid # toConstr :: Ulid -> Constr # dataTypeOf :: Ulid -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Ulid) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Ulid) # gmapT :: (forall b. Data b => b -> b) -> Ulid -> Ulid # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Ulid -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Ulid -> r # gmapQ :: (forall d. Data d => d -> u) -> Ulid -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Ulid -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Ulid -> m Ulid # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Ulid -> m Ulid # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Ulid -> m Ulid #
Storable Ulid Source #
Instance details Defined in Data.Ulid Methods sizeOf :: Ulid -> Int # alignment :: Ulid -> Int # peekElemOff :: Ptr Ulid -> Int -> IO Ulid # pokeElemOff :: Ptr Ulid -> Int -> Ulid -> IO () # peekByteOff :: Ptr b -> Int -> IO Ulid # pokeByteOff :: Ptr b -> Int -> Ulid -> IO () # peek :: Ptr Ulid -> IO Ulid # poke :: Ptr Ulid -> Ulid -> IO () #
Bits Ulid Source #
Instance details Defined in Data.Ulid Methods (.&.) :: Ulid -> Ulid -> Ulid # (.\|.) :: Ulid -> Ulid -> Ulid # xor :: Ulid -> Ulid -> Ulid # complement :: Ulid -> Ulid # shift :: Ulid -> Int -> Ulid # rotate :: Ulid -> Int -> Ulid # zeroBits :: Ulid # bit :: Int -> Ulid # setBit :: Ulid -> Int -> Ulid # clearBit :: Ulid -> Int -> Ulid # complementBit :: Ulid -> Int -> Ulid # testBit :: Ulid -> Int -> Bool # bitSizeMaybe :: Ulid -> Maybe Int # bitSize :: Ulid -> Int # isSigned :: Ulid -> Bool # shiftL :: Ulid -> Int -> Ulid # unsafeShiftL :: Ulid -> Int -> Ulid # shiftR :: Ulid -> Int -> Ulid # unsafeShiftR :: Ulid -> Int -> Ulid # rotateL :: Ulid -> Int -> Ulid # rotateR :: Ulid -> Int -> Ulid # popCount :: Ulid -> Int #
FiniteBits Ulid Source #
Instance details Defined in Data.Ulid Methods finiteBitSize :: Ulid -> Int # countLeadingZeros :: Ulid -> Int # countTrailingZeros :: Ulid -> Int #
Bounded Ulid Source #
Instance details Defined in Data.Ulid Methods minBound :: Ulid # maxBound :: Ulid #
Enum Ulid Source #
Instance details Defined in Data.Ulid Methods succ :: Ulid -> Ulid # pred :: Ulid -> Ulid # toEnum :: Int -> Ulid # fromEnum :: Ulid -> Int # enumFrom :: Ulid -> [Ulid] # enumFromThen :: Ulid -> Ulid -> [Ulid] # enumFromTo :: Ulid -> Ulid -> [Ulid] # enumFromThenTo :: Ulid -> Ulid -> Ulid -> [Ulid] #
Generic Ulid Source #
Instance details Defined in Data.Ulid Associated Types type Rep Ulid :: Type -> Type # Methods from :: Ulid -> Rep Ulid x # to :: Rep Ulid x -> Ulid #
Ix Ulid Source #
Instance details Defined in Data.Ulid Methods range :: (Ulid, Ulid) -> [Ulid] # index :: (Ulid, Ulid) -> Ulid -> Int # unsafeIndex :: (Ulid, Ulid) -> Ulid -> Int # inRange :: (Ulid, Ulid) -> Ulid -> Bool # rangeSize :: (Ulid, Ulid) -> Int # unsafeRangeSize :: (Ulid, Ulid) -> Int #
Read Ulid Source #
Instance details Defined in Data.Ulid Methods readsPrec :: Int -> ReadS Ulid # readList :: ReadS [Ulid] # readPrec :: ReadPrec Ulid # readListPrec :: ReadPrec [Ulid] #
Show Ulid Source #
Instance details Defined in Data.Ulid Methods showsPrec :: Int -> Ulid -> ShowS # show :: Ulid -> String # showList :: [Ulid] -> ShowS #
Binary Ulid Source #	big endian order
Instance details Defined in Data.Ulid Methods put :: Ulid -> Put # get :: Get Ulid # putList :: [Ulid] -> Put #
NFData Ulid Source #
Instance details Defined in Data.Ulid Methods rnf :: Ulid -> () #
Eq Ulid Source #
Instance details Defined in Data.Ulid Methods (==) :: Ulid -> Ulid -> Bool # (/=) :: Ulid -> Ulid -> Bool #
Ord Ulid Source #
Instance details Defined in Data.Ulid Methods compare :: Ulid -> Ulid -> Ordering # (<) :: Ulid -> Ulid -> Bool # (<=) :: Ulid -> Ulid -> Bool # (>) :: Ulid -> Ulid -> Bool # (>=) :: Ulid -> Ulid -> Bool # max :: Ulid -> Ulid -> Ulid # min :: Ulid -> Ulid -> Ulid #
Hashable Ulid Source #
Instance details Defined in Data.Ulid Methods hashWithSalt :: Int -> Ulid -> Int # hash :: Ulid -> Int #
Prim Ulid Source #
Instance details Defined in Data.Ulid Methods sizeOfType# :: Proxy Ulid -> Int# # sizeOf# :: Ulid -> Int# # alignmentOfType# :: Proxy Ulid -> Int# # alignment# :: Ulid -> Int# # indexByteArray# :: ByteArray# -> Int# -> Ulid # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, Ulid #) # writeByteArray# :: MutableByteArray# s -> Int# -> Ulid -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> Ulid -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> Ulid # readOffAddr# :: Addr# -> Int# -> State# s -> (# State# s, Ulid #) # writeOffAddr# :: Addr# -> Int# -> Ulid -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> Ulid -> State# s -> State# s #
Random Ulid Source #	random = uniform
Instance details Defined in Data.Ulid Methods randomR :: RandomGen g => (Ulid, Ulid) -> g -> (Ulid, g) # random :: RandomGen g => g -> (Ulid, g) # randomRs :: RandomGen g => (Ulid, Ulid) -> g -> [Ulid] # randoms :: RandomGen g => g -> [Ulid] #
Uniform Ulid Source #	generates 128-bit random entropy, may be irregular as ULID
Instance details Defined in Data.Ulid Methods uniformM :: StatefulGen g m => g -> m Ulid #
Lift Ulid Source #
Instance details Defined in Data.Ulid Methods lift :: Quote m => Ulid -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Ulid -> Code m Ulid #
type Rep Ulid Source #
Instance details Defined in Data.Ulid type Rep Ulid = D1 ('MetaData "Ulid" "Data.Ulid" "ulid-tight-0.1-78nBmQ9rUk753ZbW0DZBPv" 'False) (C1 ('MetaCons "Ulid" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)))

nil :: Ulid Source #

nil = minBound

getUlid :: (MonadIO m, StatefulGen g m) => g -> m Ulid Source #

Generates POSIXTime and random entropy, then combines it into one Ulid.

getUlid gen = do
  t <- liftIO getPOSIXTime
  randomUlidM t gen

randomUlidM :: StatefulGen g m => POSIXTime -> g -> m Ulid Source #

genUlid :: RandomGen g => POSIXTime -> g -> (Ulid, g) Source #

showUlid :: Ulid -> Text Source #

Uses upper case.

readUlid :: Text -> Maybe Ulid Source #

case-insensitive