MessageDb.Message

Documentation

newtype MessageId

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

Constructors

MessageId

Fields

• messageIdToUUID :: UUID

Instances

Eq MessageId

Defined in MessageDb.Message

Methods

(==) :: MessageId -> MessageId -> Bool

(/=) :: MessageId -> MessageId -> Bool

Ord MessageId

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

Defined in MessageDb.Message

Methods

showsPrec :: Int -> MessageId -> ShowS

show :: MessageId -> String

showList :: [MessageId] -> ShowS

ToJSON MessageId

Defined in MessageDb.Message

Methods

toJSON :: MessageId -> Value

toEncoding :: MessageId -> Encoding

toJSONList :: [MessageId] -> Value

toEncodingList :: [MessageId] -> Encoding

FromJSON MessageId

Defined in MessageDb.Message

Methods

parseJSON :: Value -> Parser MessageId

parseJSONList :: Value -> Parser [MessageId]

newMessageId :: IO MessageId

Create a new unique message id.

newtype MessageType

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

Eq MessageType

Defined in MessageDb.Message

Methods

(==) :: MessageType -> MessageType -> Bool

(/=) :: MessageType -> MessageType -> Bool

Ord MessageType

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

Defined in MessageDb.Message

Methods

showsPrec :: Int -> MessageType -> ShowS

show :: MessageType -> String

showList :: [MessageType] -> ShowS

IsString MessageType

Defined in MessageDb.Message

Methods

fromString :: String -> MessageType

ToJSON MessageType

Defined in MessageDb.Message

Methods

toJSON :: MessageType -> Value

toEncoding :: MessageType -> Encoding

toJSONList :: [MessageType] -> Value

toEncodingList :: [MessageType] -> Encoding

FromJSON MessageType

Defined in MessageDb.Message

Methods

parseJSON :: Value -> Parser MessageType

parseJSONList :: Value -> Parser [MessageType]

messageTypeOf :: forall payload. Typeable payload => MessageType

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

newtype StreamPosition

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

Constructors

StreamPosition

Fields

• streamPositionToNatural :: Natural

Instances

Enum StreamPosition

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

Defined in MessageDb.Message

Methods

(==) :: StreamPosition -> StreamPosition -> Bool

(/=) :: StreamPosition -> StreamPosition -> Bool

Integral StreamPosition

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

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

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

Defined in MessageDb.Message

Methods

toRational :: StreamPosition -> Rational

Show StreamPosition

Defined in MessageDb.Message

Methods

showsPrec :: Int -> StreamPosition -> ShowS

show :: StreamPosition -> String

showList :: [StreamPosition] -> ShowS

ToJSON StreamPosition

Defined in MessageDb.Message

Methods

toJSON :: StreamPosition -> Value

toEncoding :: StreamPosition -> Encoding

toJSONList :: [StreamPosition] -> Value

toEncodingList :: [StreamPosition] -> Encoding

FromJSON StreamPosition

Defined in MessageDb.Message

Methods

parseJSON :: Value -> Parser StreamPosition

parseJSONList :: Value -> Parser [StreamPosition]

newtype GlobalPosition

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

Constructors

GlobalPosition

Fields

• globalPositionToInteger :: Integer

Instances

Enum GlobalPosition

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

Defined in MessageDb.Message

Methods

(==) :: GlobalPosition -> GlobalPosition -> Bool

(/=) :: GlobalPosition -> GlobalPosition -> Bool

Integral GlobalPosition

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

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

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

Defined in MessageDb.Message

Methods

toRational :: GlobalPosition -> Rational

Show GlobalPosition

Defined in MessageDb.Message

Methods

showsPrec :: Int -> GlobalPosition -> ShowS

show :: GlobalPosition -> String

showList :: [GlobalPosition] -> ShowS

ToJSON GlobalPosition

Defined in MessageDb.Message

Methods

toJSON :: GlobalPosition -> Value

toEncoding :: GlobalPosition -> Encoding

toJSONList :: [GlobalPosition] -> Value

toEncodingList :: [GlobalPosition] -> Encoding

FromJSON GlobalPosition

Defined in MessageDb.Message

Methods

parseJSON :: Value -> Parser GlobalPosition

parseJSONList :: Value -> Parser [GlobalPosition]

newtype CreatedAt

Timestamp when the message was written.

Constructors

CreatedAt

Fields

• createdAtToUTCTime :: UTCTime

Instances

Eq CreatedAt

Defined in MessageDb.Message

Methods

(==) :: CreatedAt -> CreatedAt -> Bool

(/=) :: CreatedAt -> CreatedAt -> Bool

Ord CreatedAt

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

Defined in MessageDb.Message

Methods

showsPrec :: Int -> CreatedAt -> ShowS

show :: CreatedAt -> String

showList :: [CreatedAt] -> ShowS

ToJSON CreatedAt

Defined in MessageDb.Message

Methods

toJSON :: CreatedAt -> Value

toEncoding :: CreatedAt -> Encoding

toJSONList :: [CreatedAt] -> Value

toEncodingList :: [CreatedAt] -> Encoding

FromJSON CreatedAt

Defined in MessageDb.Message

Methods

parseJSON :: Value -> Parser CreatedAt

parseJSONList :: Value -> Parser [CreatedAt]

newtype Payload

Constructors

Payload

Fields

• payloadToValue :: Value

Instances

Eq Payload

Defined in MessageDb.Message

Methods

(==) :: Payload -> Payload -> Bool

(/=) :: Payload -> Payload -> Bool

Show Payload

Defined in MessageDb.Message

Methods

showsPrec :: Int -> Payload -> ShowS

show :: Payload -> String

showList :: [Payload] -> ShowS

ToJSON Payload

Defined in MessageDb.Message

Methods

toJSON :: Payload -> Value

toEncoding :: Payload -> Encoding

toJSONList :: [Payload] -> Value

toEncodingList :: [Payload] -> Encoding

FromJSON Payload

Defined in MessageDb.Message

Methods

parseJSON :: Value -> Parser Payload

parseJSONList :: Value -> Parser [Payload]

nullPayload :: Payload

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

newtype Metadata

Constructors

Metadata

Fields

• metadataToValue :: Value

Instances

Eq Metadata

Defined in MessageDb.Message

Methods

(==) :: Metadata -> Metadata -> Bool

(/=) :: Metadata -> Metadata -> Bool

Show Metadata

Defined in MessageDb.Message

Methods

showsPrec :: Int -> Metadata -> ShowS

show :: Metadata -> String

showList :: [Metadata] -> ShowS

ToJSON Metadata

Defined in MessageDb.Message

Methods

toJSON :: Metadata -> Value

toEncoding :: Metadata -> Encoding

toJSONList :: [Metadata] -> Value

toEncodingList :: [Metadata] -> Encoding

FromJSON Metadata

Defined in MessageDb.Message

Methods

parseJSON :: Value -> Parser Metadata

parseJSONList :: Value -> Parser [Metadata]

nullMetadata :: Metadata

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

data Message

Constructors

Message

Fields

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

Instances

Eq Message

Defined in MessageDb.Message

Methods

(==) :: Message -> Message -> Bool

(/=) :: Message -> Message -> Bool

Show Message

Defined in MessageDb.Message

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

ToJSON Message

Defined in MessageDb.Message

Methods

toJSON :: Message -> Value

toEncoding :: Message -> Encoding

toJSONList :: [Message] -> Value

toEncodingList :: [Message] -> Encoding

FromJSON Message

Defined in MessageDb.Message

Methods

parseJSON :: Value -> Parser Message

parseJSONList :: Value -> Parser [Message]

MonadReader Message Handler

Defined in MessageDb.Handlers

Methods

ask :: Handler Message

local :: (Message -> Message) -> Handler a -> Handler a

reader :: (Message -> a) -> Handler a

data ParseMessageFailure

Constructors

ParseMessageFailure

Fields

• failedPayloadReason :: Maybe String
• failedMetadataReason :: Maybe String

Instances

Eq ParseMessageFailure

Defined in MessageDb.Message

Methods

(==) :: ParseMessageFailure -> ParseMessageFailure -> Bool

(/=) :: ParseMessageFailure -> ParseMessageFailure -> Bool

Show ParseMessageFailure

Defined in MessageDb.Message

Methods

showsPrec :: Int -> ParseMessageFailure -> ShowS

show :: ParseMessageFailure -> String

showList :: [ParseMessageFailure] -> ShowS

Exception ParseMessageFailure

Defined in MessageDb.Message

Methods

toException :: ParseMessageFailure -> SomeException

fromException :: SomeException -> Maybe ParseMessageFailure

displayException :: ParseMessageFailure -> String

data ParsedMessage payload metadata

Constructors

ParsedMessage

Fields

• parsedPayload :: payload
• parsedMetadata :: metadata

Instances

(Eq payload, Eq metadata) => Eq (ParsedMessage payload metadata)

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)

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)