Safe Haskell	None
Language	Haskell2010

MessageDb.Message

Synopsis

newtype MessageId = MessageId {
- messageIdToUUID :: UUID
}
newMessageId :: IO MessageId
newtype MessageType = MessageType {
- messageTypeToText :: Text
}
messageTypeOf :: forall payload. Typeable payload => MessageType
newtype StreamPosition = StreamPosition {
- streamPositionToNatural :: Natural
}
newtype GlobalPosition = GlobalPosition {
- globalPositionToInteger :: Integer
}
newtype CreatedAt = CreatedAt {
- createdAtToUTCTime :: UTCTime
}
newtype Payload = Payload {
- payloadToValue :: Value
}
nullPayload :: Payload
parsePayload :: FromJSON value => Payload -> Either String value
newtype Metadata = Metadata {
- metadataToValue :: Value
}
nullMetadata :: Metadata
parseMetadata :: FromJSON value => Metadata -> Either String value
data Message = Message {
- messageId :: MessageId
- messageStream :: StreamName
- messageType :: MessageType
- messageStreamPosition :: StreamPosition
- messageGlobalPosition :: GlobalPosition
- messageCreatedAt :: CreatedAt
- messagePayload :: Payload
- messageMetadata :: Metadata
}
data ParseMessageFailure = ParseMessageFailure {
- failedPayloadReason :: Maybe String
- failedMetadataReason :: Maybe String
}
data ParsedMessage payload metadata = ParsedMessage {
- parsedPayload :: payload
- parsedMetadata :: metadata
}
parseMessage :: (FromJSON payload, FromJSON metadata) => Message -> Either ParseMessageFailure (ParsedMessage payload metadata)

Documentation

newtype MessageId Source #

Unique id of a message. Most be unique across the entire event store.

Constructors

MessageId
Fields messageIdToUUID :: UUID

Instances

Instances details

Eq MessageId Source #
Instance details Defined in MessageDb.Message Methods (==) :: MessageId -> MessageId -> Bool # (/=) :: MessageId -> MessageId -> Bool #
Ord MessageId Source #
Instance details Defined in MessageDb.Message Methods compare :: MessageId -> MessageId -> Ordering # (<) :: MessageId -> MessageId -> Bool # (<=) :: MessageId -> MessageId -> Bool # (>) :: MessageId -> MessageId -> Bool # (>=) :: MessageId -> MessageId -> Bool # max :: MessageId -> MessageId -> MessageId # min :: MessageId -> MessageId -> MessageId #
Show MessageId Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> MessageId -> ShowS # show :: MessageId -> String # showList :: [MessageId] -> ShowS #
ToJSON MessageId Source #
Instance details Defined in MessageDb.Message Methods toJSON :: MessageId -> Value # toEncoding :: MessageId -> Encoding # toJSONList :: [MessageId] -> Value # toEncodingList :: [MessageId] -> Encoding #
FromJSON MessageId Source #
Instance details Defined in MessageDb.Message Methods parseJSON :: Value -> Parser MessageId # parseJSONList :: Value -> Parser [MessageId] #

newMessageId :: IO MessageId Source #

Create a new unique message id.

newtype MessageType Source #

The type of a message. You can use this later to determine what kind of event or command a message is.

Constructors

MessageType
Fields messageTypeToText :: Text

Instances

Instances details

Eq MessageType Source #
Instance details Defined in MessageDb.Message Methods (==) :: MessageType -> MessageType -> Bool # (/=) :: MessageType -> MessageType -> Bool #
Ord MessageType Source #
Instance details Defined in MessageDb.Message Methods compare :: MessageType -> MessageType -> Ordering # (<) :: MessageType -> MessageType -> Bool # (<=) :: MessageType -> MessageType -> Bool # (>) :: MessageType -> MessageType -> Bool # (>=) :: MessageType -> MessageType -> Bool # max :: MessageType -> MessageType -> MessageType # min :: MessageType -> MessageType -> MessageType #
Show MessageType Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> MessageType -> ShowS # show :: MessageType -> String # showList :: [MessageType] -> ShowS #
IsString MessageType Source #
Instance details Defined in MessageDb.Message Methods fromString :: String -> MessageType #
ToJSON MessageType Source #
Instance details Defined in MessageDb.Message Methods toJSON :: MessageType -> Value # toEncoding :: MessageType -> Encoding # toJSONList :: [MessageType] -> Value # toEncodingList :: [MessageType] -> Encoding #
FromJSON MessageType Source #
Instance details Defined in MessageDb.Message Methods parseJSON :: Value -> Parser MessageType # parseJSONList :: Value -> Parser [MessageType] #

messageTypeOf :: forall payload. Typeable payload => MessageType Source #

Converts a type's name to a MessageType. For example 'typeOf @Bool' will be 'MessageType Bool'.

newtype StreamPosition Source #

Position within a stream. This starts at 0 and has no gaps.

Constructors

StreamPosition
Fields streamPositionToNatural :: Natural

Instances

Instances details

Enum StreamPosition Source #
Instance details Defined in MessageDb.Message Methods succ :: StreamPosition -> StreamPosition # pred :: StreamPosition -> StreamPosition # toEnum :: Int -> StreamPosition # fromEnum :: StreamPosition -> Int # enumFrom :: StreamPosition -> [StreamPosition] # enumFromThen :: StreamPosition -> StreamPosition -> [StreamPosition] # enumFromTo :: StreamPosition -> StreamPosition -> [StreamPosition] # enumFromThenTo :: StreamPosition -> StreamPosition -> StreamPosition -> [StreamPosition] #
Eq StreamPosition Source #
Instance details Defined in MessageDb.Message Methods (==) :: StreamPosition -> StreamPosition -> Bool # (/=) :: StreamPosition -> StreamPosition -> Bool #
Integral StreamPosition Source #
Instance details Defined in MessageDb.Message Methods quot :: StreamPosition -> StreamPosition -> StreamPosition # rem :: StreamPosition -> StreamPosition -> StreamPosition # div :: StreamPosition -> StreamPosition -> StreamPosition # mod :: StreamPosition -> StreamPosition -> StreamPosition # quotRem :: StreamPosition -> StreamPosition -> (StreamPosition, StreamPosition) # divMod :: StreamPosition -> StreamPosition -> (StreamPosition, StreamPosition) # toInteger :: StreamPosition -> Integer #
Num StreamPosition Source #
Instance details Defined in MessageDb.Message Methods (+) :: StreamPosition -> StreamPosition -> StreamPosition # (-) :: StreamPosition -> StreamPosition -> StreamPosition # (*) :: StreamPosition -> StreamPosition -> StreamPosition # negate :: StreamPosition -> StreamPosition # abs :: StreamPosition -> StreamPosition # signum :: StreamPosition -> StreamPosition # fromInteger :: Integer -> StreamPosition #
Ord StreamPosition Source #
Instance details Defined in MessageDb.Message Methods compare :: StreamPosition -> StreamPosition -> Ordering # (<) :: StreamPosition -> StreamPosition -> Bool # (<=) :: StreamPosition -> StreamPosition -> Bool # (>) :: StreamPosition -> StreamPosition -> Bool # (>=) :: StreamPosition -> StreamPosition -> Bool # max :: StreamPosition -> StreamPosition -> StreamPosition # min :: StreamPosition -> StreamPosition -> StreamPosition #
Real StreamPosition Source #
Instance details Defined in MessageDb.Message Methods toRational :: StreamPosition -> Rational #
Show StreamPosition Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> StreamPosition -> ShowS # show :: StreamPosition -> String # showList :: [StreamPosition] -> ShowS #
ToJSON StreamPosition Source #
Instance details Defined in MessageDb.Message Methods toJSON :: StreamPosition -> Value # toEncoding :: StreamPosition -> Encoding # toJSONList :: [StreamPosition] -> Value # toEncodingList :: [StreamPosition] -> Encoding #
FromJSON StreamPosition Source #
Instance details Defined in MessageDb.Message Methods parseJSON :: Value -> Parser StreamPosition # parseJSONList :: Value -> Parser [StreamPosition] #

newtype GlobalPosition Source #

Primary key. The ordinal position of the message in the entire message store. Global position may have gaps.

Constructors

GlobalPosition
Fields globalPositionToInteger :: Integer

Instances

Instances details

Enum GlobalPosition Source #
Instance details Defined in MessageDb.Message Methods succ :: GlobalPosition -> GlobalPosition # pred :: GlobalPosition -> GlobalPosition # toEnum :: Int -> GlobalPosition # fromEnum :: GlobalPosition -> Int # enumFrom :: GlobalPosition -> [GlobalPosition] # enumFromThen :: GlobalPosition -> GlobalPosition -> [GlobalPosition] # enumFromTo :: GlobalPosition -> GlobalPosition -> [GlobalPosition] # enumFromThenTo :: GlobalPosition -> GlobalPosition -> GlobalPosition -> [GlobalPosition] #
Eq GlobalPosition Source #
Instance details Defined in MessageDb.Message Methods (==) :: GlobalPosition -> GlobalPosition -> Bool # (/=) :: GlobalPosition -> GlobalPosition -> Bool #
Integral GlobalPosition Source #
Instance details Defined in MessageDb.Message Methods quot :: GlobalPosition -> GlobalPosition -> GlobalPosition # rem :: GlobalPosition -> GlobalPosition -> GlobalPosition # div :: GlobalPosition -> GlobalPosition -> GlobalPosition # mod :: GlobalPosition -> GlobalPosition -> GlobalPosition # quotRem :: GlobalPosition -> GlobalPosition -> (GlobalPosition, GlobalPosition) # divMod :: GlobalPosition -> GlobalPosition -> (GlobalPosition, GlobalPosition) # toInteger :: GlobalPosition -> Integer #
Num GlobalPosition Source #
Instance details Defined in MessageDb.Message Methods (+) :: GlobalPosition -> GlobalPosition -> GlobalPosition # (-) :: GlobalPosition -> GlobalPosition -> GlobalPosition # (*) :: GlobalPosition -> GlobalPosition -> GlobalPosition # negate :: GlobalPosition -> GlobalPosition # abs :: GlobalPosition -> GlobalPosition # signum :: GlobalPosition -> GlobalPosition # fromInteger :: Integer -> GlobalPosition #
Ord GlobalPosition Source #
Instance details Defined in MessageDb.Message Methods compare :: GlobalPosition -> GlobalPosition -> Ordering # (<) :: GlobalPosition -> GlobalPosition -> Bool # (<=) :: GlobalPosition -> GlobalPosition -> Bool # (>) :: GlobalPosition -> GlobalPosition -> Bool # (>=) :: GlobalPosition -> GlobalPosition -> Bool # max :: GlobalPosition -> GlobalPosition -> GlobalPosition # min :: GlobalPosition -> GlobalPosition -> GlobalPosition #
Real GlobalPosition Source #
Instance details Defined in MessageDb.Message Methods toRational :: GlobalPosition -> Rational #
Show GlobalPosition Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> GlobalPosition -> ShowS # show :: GlobalPosition -> String # showList :: [GlobalPosition] -> ShowS #
ToJSON GlobalPosition Source #
Instance details Defined in MessageDb.Message Methods toJSON :: GlobalPosition -> Value # toEncoding :: GlobalPosition -> Encoding # toJSONList :: [GlobalPosition] -> Value # toEncodingList :: [GlobalPosition] -> Encoding #
FromJSON GlobalPosition Source #
Instance details Defined in MessageDb.Message Methods parseJSON :: Value -> Parser GlobalPosition # parseJSONList :: Value -> Parser [GlobalPosition] #

newtype CreatedAt Source #

Timestamp when the message was written.

Constructors

CreatedAt
Fields createdAtToUTCTime :: UTCTime

Instances

Instances details

Eq CreatedAt Source #
Instance details Defined in MessageDb.Message Methods (==) :: CreatedAt -> CreatedAt -> Bool # (/=) :: CreatedAt -> CreatedAt -> Bool #
Ord CreatedAt Source #
Instance details Defined in MessageDb.Message Methods compare :: CreatedAt -> CreatedAt -> Ordering # (<) :: CreatedAt -> CreatedAt -> Bool # (<=) :: CreatedAt -> CreatedAt -> Bool # (>) :: CreatedAt -> CreatedAt -> Bool # (>=) :: CreatedAt -> CreatedAt -> Bool # max :: CreatedAt -> CreatedAt -> CreatedAt # min :: CreatedAt -> CreatedAt -> CreatedAt #
Show CreatedAt Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> CreatedAt -> ShowS # show :: CreatedAt -> String # showList :: [CreatedAt] -> ShowS #
ToJSON CreatedAt Source #
Instance details Defined in MessageDb.Message Methods toJSON :: CreatedAt -> Value # toEncoding :: CreatedAt -> Encoding # toJSONList :: [CreatedAt] -> Value # toEncodingList :: [CreatedAt] -> Encoding #
FromJSON CreatedAt Source #
Instance details Defined in MessageDb.Message Methods parseJSON :: Value -> Parser CreatedAt # parseJSONList :: Value -> Parser [CreatedAt] #

newtype Payload Source #

Constructors

Payload
Fields payloadToValue :: Value

Instances

Instances details

Eq Payload Source #
Instance details Defined in MessageDb.Message Methods (==) :: Payload -> Payload -> Bool # (/=) :: Payload -> Payload -> Bool #
Show Payload Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> Payload -> ShowS # show :: Payload -> String # showList :: [Payload] -> ShowS #
ToJSON Payload Source #
Instance details Defined in MessageDb.Message Methods toJSON :: Payload -> Value # toEncoding :: Payload -> Encoding # toJSONList :: [Payload] -> Value # toEncodingList :: [Payload] -> Encoding #
FromJSON Payload Source #
Instance details Defined in MessageDb.Message Methods parseJSON :: Value -> Parser Payload # parseJSONList :: Value -> Parser [Payload] #

nullPayload :: Payload Source #

parsePayload :: FromJSON value => Payload -> Either String value Source #

newtype Metadata Source #

Constructors

Metadata
Fields metadataToValue :: Value

Instances

Instances details

Eq Metadata Source #
Instance details Defined in MessageDb.Message Methods (==) :: Metadata -> Metadata -> Bool # (/=) :: Metadata -> Metadata -> Bool #
Show Metadata Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
ToJSON Metadata Source #
Instance details Defined in MessageDb.Message Methods toJSON :: Metadata -> Value # toEncoding :: Metadata -> Encoding # toJSONList :: [Metadata] -> Value # toEncodingList :: [Metadata] -> Encoding #
FromJSON Metadata Source #
Instance details Defined in MessageDb.Message Methods parseJSON :: Value -> Parser Metadata # parseJSONList :: Value -> Parser [Metadata] #

nullMetadata :: Metadata Source #

parseMetadata :: FromJSON value => Metadata -> Either String value Source #

data Message Source #

Constructors

Message
Fields messageId :: MessageId messageStream :: StreamName messageType :: MessageType messageStreamPosition :: StreamPosition messageGlobalPosition :: GlobalPosition messageCreatedAt :: CreatedAt messagePayload :: Payload messageMetadata :: Metadata

Instances

Instances details

Eq Message Source #
Instance details Defined in MessageDb.Message Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Show Message Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
ToJSON Message Source #
Instance details Defined in MessageDb.Message Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding #
FromJSON Message Source #
Instance details Defined in MessageDb.Message Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] #
MonadReader Message Handler Source #
Instance details Defined in MessageDb.Handlers Methods ask :: Handler Message # local :: (Message -> Message) -> Handler a -> Handler a # reader :: (Message -> a) -> Handler a #

data ParseMessageFailure Source #

Constructors

ParseMessageFailure
Fields failedPayloadReason :: Maybe String failedMetadataReason :: Maybe String

Instances

Instances details

Eq ParseMessageFailure Source #
Instance details Defined in MessageDb.Message Methods (==) :: ParseMessageFailure -> ParseMessageFailure -> Bool # (/=) :: ParseMessageFailure -> ParseMessageFailure -> Bool #
Show ParseMessageFailure Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> ParseMessageFailure -> ShowS # show :: ParseMessageFailure -> String # showList :: [ParseMessageFailure] -> ShowS #
ToJSON ParseMessageFailure Source #
Instance details Defined in MessageDb.Message Methods toJSON :: ParseMessageFailure -> Value # toEncoding :: ParseMessageFailure -> Encoding # toJSONList :: [ParseMessageFailure] -> Value # toEncodingList :: [ParseMessageFailure] -> Encoding #
FromJSON ParseMessageFailure Source #
Instance details Defined in MessageDb.Message Methods parseJSON :: Value -> Parser ParseMessageFailure # parseJSONList :: Value -> Parser [ParseMessageFailure] #
Exception ParseMessageFailure Source #
Instance details Defined in MessageDb.Message Methods toException :: ParseMessageFailure -> SomeException # fromException :: SomeException -> Maybe ParseMessageFailure # displayException :: ParseMessageFailure -> String #

data ParsedMessage payload metadata Source #

Constructors

ParsedMessage
Fields parsedPayload :: payload parsedMetadata :: metadata

Instances

Instances details

(Eq payload, Eq metadata) => Eq (ParsedMessage payload metadata) Source #
Instance details Defined in MessageDb.Message Methods (==) :: ParsedMessage payload metadata -> ParsedMessage payload metadata -> Bool # (/=) :: ParsedMessage payload metadata -> ParsedMessage payload metadata -> Bool #
(Show payload, Show metadata) => Show (ParsedMessage payload metadata) Source #
Instance details Defined in MessageDb.Message Methods showsPrec :: Int -> ParsedMessage payload metadata -> ShowS # show :: ParsedMessage payload metadata -> String # showList :: [ParsedMessage payload metadata] -> ShowS #

parseMessage :: (FromJSON payload, FromJSON metadata) => Message -> Either ParseMessageFailure (ParsedMessage payload metadata) Source #