EventSource.Types

Documentation

data Data

Opaque data type used to store raw data.

Constructors

Data ByteString

DataAsJson Value

Instances

Show Data

Methods

showsPrec :: Int -> Data -> ShowS

show :: Data -> String

showList :: [Data] -> ShowS

newtype JsonParsing a

Sometimes, having to implement a FromJSON instance isn't flexible enough. JsonParsing allow to pass parameters when parsing from a JSON value while remaining composable.

Constructors

JsonParsing (Value -> Parser a)

Instances

Monad JsonParsing

Methods

(>>=) :: JsonParsing a -> (a -> JsonParsing b) -> JsonParsing b

(>>) :: JsonParsing a -> JsonParsing b -> JsonParsing b

return :: a -> JsonParsing a

fail :: String -> JsonParsing a

Functor JsonParsing

Methods

fmap :: (a -> b) -> JsonParsing a -> JsonParsing b

(<$) :: a -> JsonParsing b -> JsonParsing a

Applicative JsonParsing

Methods

pure :: a -> JsonParsing a

(<*>) :: JsonParsing (a -> b) -> JsonParsing a -> JsonParsing b

(*>) :: JsonParsing a -> JsonParsing b -> JsonParsing b

(<*) :: JsonParsing a -> JsonParsing b -> JsonParsing a

dataAsBytes :: Data -> ByteString

Returns Data content as a ByteString.

dataFromBytes :: ByteString -> Data

Creates a Data object from a raw ByteString.

dataFromJson :: ToJSON a => a -> Data

Creates a Data object from a JSON object.

dataAsJson :: FromJSON a => Data -> Either Text a

Returns Data content as any value that implements FromJSON type-class.

dataAsParsing :: Data -> JsonParsing a -> Either Text a

Uses a JsonParsing comuputation to extract a value.

dataAsParse :: Data -> (Value -> Parser a) -> Either Text a

Like dataAsParsing but doesn't require you to use JsonParsing.

newtype Properties

Used to store a set a properties. One example is to be used as Event metadata.

Constructors

Properties (Map Text Text)

Instances

Show Properties

Methods

showsPrec :: Int -> Properties -> ShowS

show :: Properties -> String

showList :: [Properties] -> ShowS

Monoid Properties

Methods

mempty :: Properties

mappend :: Properties -> Properties -> Properties

mconcat :: [Properties] -> Properties

ToJSON Properties

Methods

toJSON :: Properties -> Value

toEncoding :: Properties -> Encoding

toJSONList :: [Properties] -> Value

toEncodingList :: [Properties] -> Encoding

FromJSON Properties

Methods

parseJSON :: Value -> Parser Properties

parseJSONList :: Value -> Parser [Properties]

property :: MonadPlus m => Text -> Properties -> m Text

Retrieves a value associated with the given key.

singleton :: Text -> Text -> Properties

Builds a Properties with a single pair of key-value.

setProperty :: Text -> Text -> Properties -> Properties

Adds a pair of key-value into given Properties.

properties :: Properties -> [(Text, Text)]

Returns all associated key-value pairs as a list.

newtype EventId

Used to identify an event.

Constructors

EventId UUID

Instances

Eq EventId

Methods

(==) :: EventId -> EventId -> Bool

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

Ord EventId

Methods

compare :: EventId -> EventId -> Ordering

(<) :: EventId -> EventId -> Bool

(<=) :: EventId -> EventId -> Bool

(>) :: EventId -> EventId -> Bool

(>=) :: EventId -> EventId -> Bool

max :: EventId -> EventId -> EventId

min :: EventId -> EventId -> EventId

Show EventId

Methods

showsPrec :: Int -> EventId -> ShowS

show :: EventId -> String

showList :: [EventId] -> ShowS

freshEventId :: MonadIO m => m EventId

Generates a fresh EventId.

newtype StreamName

Represents a stream name.

Constructors

StreamName Text

Instances

Eq StreamName

Methods

(==) :: StreamName -> StreamName -> Bool

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

Ord StreamName

Methods

compare :: StreamName -> StreamName -> Ordering

(<) :: StreamName -> StreamName -> Bool

(<=) :: StreamName -> StreamName -> Bool

(>) :: StreamName -> StreamName -> Bool

(>=) :: StreamName -> StreamName -> Bool

max :: StreamName -> StreamName -> StreamName

min :: StreamName -> StreamName -> StreamName

Show StreamName

Methods

showsPrec :: Int -> StreamName -> ShowS

show :: StreamName -> String

showList :: [StreamName] -> ShowS

IsString StreamName

Methods

fromString :: String -> StreamName

newtype EventType

Used to identity the type of an Event.

Constructors

EventType Text

Instances

Eq EventType

Methods

(==) :: EventType -> EventType -> Bool

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

Show EventType

Methods

showsPrec :: Int -> EventType -> ShowS

show :: EventType -> String

showList :: [EventType] -> ShowS

IsString EventType

Methods

fromString :: String -> EventType

setEventType :: EventType -> State Event ()

Sets EventType for an Event.

setEventId :: EventId -> State Event ()

Sets Eventid for an Event.

setEventPayload :: Data -> State Event ()

Sets a payload for an Event.

setEventMetadata :: Properties -> State Event ()

Sets metadata for an Event.

data Event

Encapsulates an event which is about to be saved.

Constructors

Event

Fields

• eventType :: EventType
• eventId :: EventId
• eventPayload :: Data
• eventMetadata :: Maybe Properties

Instances

Show Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

DecodeEvent Event

Methods

decodeEvent :: Event -> Either Text Event

newtype EventNumber

Represents an event index in a stream.

Constructors

EventNumber Int32

Instances

Enum EventNumber

Methods

succ :: EventNumber -> EventNumber

pred :: EventNumber -> EventNumber

toEnum :: Int -> EventNumber

fromEnum :: EventNumber -> Int

enumFrom :: EventNumber -> [EventNumber]

enumFromThen :: EventNumber -> EventNumber -> [EventNumber]

enumFromTo :: EventNumber -> EventNumber -> [EventNumber]

enumFromThenTo :: EventNumber -> EventNumber -> EventNumber -> [EventNumber]

Eq EventNumber

Methods

(==) :: EventNumber -> EventNumber -> Bool

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

Num EventNumber

Methods

(+) :: EventNumber -> EventNumber -> EventNumber

(-) :: EventNumber -> EventNumber -> EventNumber

(*) :: EventNumber -> EventNumber -> EventNumber

negate :: EventNumber -> EventNumber

abs :: EventNumber -> EventNumber

signum :: EventNumber -> EventNumber

fromInteger :: Integer -> EventNumber

Ord EventNumber

Methods

compare :: EventNumber -> EventNumber -> Ordering

(<) :: EventNumber -> EventNumber -> Bool

(<=) :: EventNumber -> EventNumber -> Bool

(>) :: EventNumber -> EventNumber -> Bool

(>=) :: EventNumber -> EventNumber -> Bool

max :: EventNumber -> EventNumber -> EventNumber

min :: EventNumber -> EventNumber -> EventNumber

Show EventNumber

Methods

showsPrec :: Int -> EventNumber -> ShowS

show :: EventNumber -> String

showList :: [EventNumber] -> ShowS

data SavedEvent

Represents an event that's saved into the event store.

Constructors

SavedEvent

Fields

• eventNumber :: EventNumber
• savedEvent :: Event

Instances

Show SavedEvent

Methods

showsPrec :: Int -> SavedEvent -> ShowS

show :: SavedEvent -> String

showList :: [SavedEvent] -> ShowS

savedEventAs :: DecodeEvent a => SavedEvent -> Either Text a

Deserializes a SavedEvent.

data Slice

Represents batch of events read from a store.

Constructors

Slice

Fields

• sliceEvents :: [SavedEvent]
• sliceEndOfStream :: Bool
• sliceNextEventNumber :: EventNumber

Instances

Show Slice

Methods

showsPrec :: Int -> Slice -> ShowS

show :: Slice -> String

showList :: [Slice] -> ShowS

sliceEventsAs :: DecodeEvent a => Slice -> Either Text [a]

Deserializes a Slice's events.

class EncodeEvent a where

Encodes a data object into an Event. encodeEvent get passed an EventId in a case where a fresh id is needed.

Minimal complete definition

encodeEvent

Methods

encodeEvent :: a -> State Event ()

class DecodeEvent a where

Decodes an Event into a data object.

Minimal complete definition

decodeEvent

Methods

decodeEvent :: Event -> Either Text a

Instances

DecodeEvent Event

Methods

decodeEvent :: Event -> Either Text Event

newtype DecodeEventException

Constructors

DecodeEventException Text

Instances

Show DecodeEventException

Methods

showsPrec :: Int -> DecodeEventException -> ShowS

show :: DecodeEventException -> String

showList :: [DecodeEventException] -> ShowS

Exception DecodeEventException

Methods

toException :: DecodeEventException -> SomeException

fromException :: SomeException -> Maybe DecodeEventException

displayException :: DecodeEventException -> String

data ExpectedVersion

The purpose of ExpectedVersion is to make sure a certain stream state is at an expected point in order to carry out a write.

Constructors

AnyVersion

NoStream

StreamExists

ExactVersion EventNumber

Instances

Show ExpectedVersion

Methods

showsPrec :: Int -> ExpectedVersion -> ShowS

show :: ExpectedVersion -> String

showList :: [ExpectedVersion] -> ShowS

data ReadStatus a

Statuses you can get on every read attempt.

Constructors

ReadSuccess a

ReadFailure ReadFailure

Instances

Functor ReadStatus

Methods

fmap :: (a -> b) -> ReadStatus a -> ReadStatus b

(<$) :: a -> ReadStatus b -> ReadStatus a

Foldable ReadStatus

Methods

fold :: Monoid m => ReadStatus m -> m

foldMap :: Monoid m => (a -> m) -> ReadStatus a -> m

foldr :: (a -> b -> b) -> b -> ReadStatus a -> b

foldr' :: (a -> b -> b) -> b -> ReadStatus a -> b

foldl :: (b -> a -> b) -> b -> ReadStatus a -> b

foldl' :: (b -> a -> b) -> b -> ReadStatus a -> b

foldr1 :: (a -> a -> a) -> ReadStatus a -> a

foldl1 :: (a -> a -> a) -> ReadStatus a -> a

toList :: ReadStatus a -> [a]

null :: ReadStatus a -> Bool

length :: ReadStatus a -> Int

elem :: Eq a => a -> ReadStatus a -> Bool

maximum :: Ord a => ReadStatus a -> a

minimum :: Ord a => ReadStatus a -> a

sum :: Num a => ReadStatus a -> a

product :: Num a => ReadStatus a -> a

Traversable ReadStatus

Methods

traverse :: Applicative f => (a -> f b) -> ReadStatus a -> f (ReadStatus b)

sequenceA :: Applicative f => ReadStatus (f a) -> f (ReadStatus a)

mapM :: Monad m => (a -> m b) -> ReadStatus a -> m (ReadStatus b)

sequence :: Monad m => ReadStatus (m a) -> m (ReadStatus a)

Show a => Show (ReadStatus a)

Methods

showsPrec :: Int -> ReadStatus a -> ShowS

show :: ReadStatus a -> String

showList :: [ReadStatus a] -> ShowS

isReadSuccess :: ReadStatus a -> Bool

Returns True is ReadStatus is a ReadSuccess.

isReadFailure :: ReadStatus a -> Bool

Returns False is ReadStatus is a ReadFailure.

data ReadFailure

Represents the different kind of failure you can get when reading.

Constructors

StreamNotFound

ReadError (Maybe Text)

AccessDenied

Instances

Show ReadFailure

Methods

showsPrec :: Int -> ReadFailure -> ShowS

show :: ReadFailure -> String

showList :: [ReadFailure] -> ShowS