Copyright	(C) 2016-2026 David M. Johnson
License	BSD3-style (see the file LICENSE)
Maintainer	David M. Johnson <code@dmj.io>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Miso.UUID

Contents

Types
String conversion
Binary conversion
Nil
Generation

Description

Overview

Miso.UUID provides a UUID type, as defined in RFC 4122, backed by a MisoString. Its API mirrors Data.UUID from the uuid package.

New v4 UUIDs are generated with the browser's crypto.randomUUID(). Parsing accepts the canonical 8-4-4-4-12 hexadecimal form, in either case, and normalizes it to lowercase.

Quick start

import Miso.UUID (tUUID)
import qualified Miso.UUID as UUID

-- Generate a fresh identifier
freshId :: IO UUID
freshId = UUID.nextRandom

-- Parse one
parsed :: Maybe UUID
parsed = UUID.fromString "550e8400-e29b-41d4-a716-446655440000"

-- Check for the nil UUID
isUnset :: UUID -> Bool
isUnset = UUID.null

Instances

UUID can be converted to and from MisoString, JSON, JSVal, and used as a route capture with Miso.Router. Its Show and Read instances use the unquoted 8-4-4-4-12 form, like Data.UUID.

Synopsis

data UUID
toString :: UUID -> String
fromString :: String -> Maybe UUID
toText :: UUID -> Text
fromText :: Text -> Maybe UUID
toASCIIBytes :: UUID -> ByteString
fromASCIIBytes :: ByteString -> Maybe UUID
toLazyASCIIBytes :: UUID -> ByteString
fromLazyASCIIBytes :: ByteString -> Maybe UUID
toByteString :: UUID -> ByteString
fromByteString :: ByteString -> Maybe UUID
toWords :: UUID -> (Word32, Word32, Word32, Word32)
fromWords :: Word32 -> Word32 -> Word32 -> Word32 -> UUID
toWords64 :: UUID -> (Word64, Word64)
fromWords64 :: Word64 -> Word64 -> UUID
null :: UUID -> Bool
nil :: UUID
nextRandom :: IO UUID

Types

data UUID Source #

A universally unique identifier, as defined in RFC 4122.

Instances

Instances details

Eq UUID Source #
Instance details Defined in Miso.UUID Methods (==) :: UUID -> UUID -> Bool # (/=) :: UUID -> UUID -> Bool #
Ord UUID Source #
Instance details Defined in Miso.UUID Methods compare :: UUID -> UUID -> Ordering # (<) :: UUID -> UUID -> Bool # (<=) :: UUID -> UUID -> Bool # (>) :: UUID -> UUID -> Bool # (>=) :: UUID -> UUID -> Bool # max :: UUID -> UUID -> UUID # min :: UUID -> UUID -> UUID #
Read UUID Source #
Instance details Defined in Miso.UUID Methods readsPrec :: Int -> ReadS UUID # readList :: ReadS [UUID] # readPrec :: ReadPrec UUID # readListPrec :: ReadPrec [UUID] #
Show UUID Source #
Instance details Defined in Miso.UUID Methods showsPrec :: Int -> UUID -> ShowS # show :: UUID -> String # showList :: [UUID] -> ShowS #
FromJSVal UUID Source #
Instance details Defined in Miso.UUID Methods fromJSVal :: JSVal -> IO (Maybe UUID) Source # fromJSValUnchecked :: JSVal -> IO UUID Source #
ToJSVal UUID Source #
Instance details Defined in Miso.UUID Methods toJSVal :: UUID -> IO JSVal Source #
FromJSON UUID Source #
Instance details Defined in Miso.UUID Methods parseJSON :: Value -> Parser UUID Source #
ToJSON UUID Source #
Instance details Defined in Miso.UUID Methods toJSON :: UUID -> Value Source # toJSONList :: [UUID] -> Value Source #
Router UUID Source #
Instance details Defined in Miso.UUID Methods fromRoute :: UUID -> [Token] Source # toURI :: UUID -> URI Source # route :: URI -> Either RoutingError UUID Source # href_ :: UUID -> Attribute model action Source # prettyRoute :: UUID -> MisoString Source # dumpURI :: UUID -> MisoString Source # toRoute :: MisoString -> Either RoutingError UUID Source # routeParser :: RouteParser UUID Source #
FromMisoString UUID Source #
Instance details Defined in Miso.UUID Methods fromMisoStringEither :: MisoString -> Either String UUID Source #
ToMisoString UUID Source #
Instance details Defined in Miso.UUID Methods toMisoString :: UUID -> MisoString Source #