Database.EventStore

Connection

data Connection

Represents a connection to a single EventStore node.

data ConnectionType

Gathers every connection type handled by the client.

Constructors

Static String Int

HostName and Port.

Cluster ClusterSettings

Dns ByteString (Maybe DnsServer) Int

Domain name, optional DNS server and port.

data Credentials

Holds login and password information.

Instances

Eq Credentials

Methods

(==) :: Credentials -> Credentials -> Bool

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

Show Credentials

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

data Settings

Global Connection settings

Constructors

Settings

Fields

• s_heartbeatInterval :: NominalDiffTime

  Maximum delay of inactivity before the client sends a heartbeat request.

• s_heartbeatTimeout :: NominalDiffTime

  Maximum delay the server has to issue a heartbeat response.

• s_requireMaster :: Bool

  On a cluster settings. Requires the master node when performing a write operation.

• s_retry :: Retry

  Retry strategy when failing to connect.

• s_reconnect_delay :: NominalDiffTime

  Delay before issuing a new connection request.

• s_ssl :: Maybe TLSSettings

  SSL settings.

• s_loggerType :: LogType

  Type of logging to use.

• s_loggerFilter :: LoggerFilter

  Restriction of what would be logged.

• s_loggerDetailed :: Bool

  Detailed logging output. Currently, it also indicates the location where the log occurred.

• s_operationTimeout :: NominalDiffTime

  Delay in which an operation will be retried if no response arrived.

• s_operationRetry :: Retry

  Retry strategy when an operation timeout.

• s_monitoring :: Maybe Store

  EKG metric store.

• s_defaultConnectionName :: Maybe Text

  Default connection name.

• s_defaultUserCredentials :: Maybe Credentials

  Credentials to use for operations where other Credentials are not explicitly supplied.

data Retry

Represents reconnection strategy.

atMost :: Int -> Retry

Indicates how many times we should try to reconnect to the server. A value less than or equal to 0 means no retry.

keepRetrying :: Retry

Indicates we should try to reconnect to the server until the end of the Universe.

credentials

Arguments

:: ByteString

Login

-> ByteString

Password

-> Credentials

Creates a Credentials given a login and a password.

defaultSettings :: Settings

Default global settings.

• s_heartbeatInterval = 750 ms
• s_heartbeatTimeout = 1500 ms
• s_requireMaster = True
• s_retry = atMost 3
• s_reconnect_delay = 3 seconds
• s_ssl = Nothing
• s_loggerType = LogNone
• s_loggerFilter = LoggerLevel LevelInfo
• s_loggerDetailed = False
• s_operationTimeout = 10 seconds
• s_operationRetry = atMost 3
• s_monitoring = Nothing
• s_defaultConnectionName = Nothing
• s_defaultUserCredentials = Nothing

defaultSSLSettings :: TLSSettings -> Settings

Default SSL settings based on defaultSettings.

connect :: Settings -> ConnectionType -> IO Connection

Creates a new Connection to a single node. It maintains a full duplex connection to the EventStore. An EventStore Connection operates quite differently than say a SQL connection. Normally when you use an EventStore connection you want to keep the connection open for a much longer of time than when you use a SQL connection.

Another difference is that with the EventStore Connection all operations are handled in a full async manner (even if you call the synchronous behaviors). Many threads can use an EvenStore Connection at the same time or a single thread can make many asynchronous requests. To get the most performance out of the connection it is generally recommended to use it in this way.

shutdown :: Connection -> IO ()

Asynchronously closes the Connection.

waitTillClosed :: Connection -> IO ()

Waits the Connection to be closed.

connectionSettings :: Connection -> Settings

Returns a Connection 's Settings.

Cluster Connection

data ClusterSettings

Contains settings related to a connection to a cluster.

Constructors

ClusterSettings

Fields

• clusterDns :: !ByteString

  The DNS name to use for discovering endpoints.

• clusterMaxDiscoverAttempts :: !Int

  The maximum number of attempts for discovering endpoints.

• clusterExternalGossipPort :: !Int

  The well-known endpoint on which cluster managers are running.

• clusterGossipSeeds :: Maybe (NonEmpty GossipSeed)

  Endpoints for seeding gossip if not using DNS.

• clusterGossipTimeout :: !TimeSpan

  Timeout for cluster gossip.

• clusterDnsServer :: !(Maybe DnsServer)

  Indicates a specific DNS server should be contacted.

data DnsServer

Tells how the DNS server should be contacted.

Constructors

DnsFilePath String

DnsHostName String

DnsHostPort String Int

data GossipSeed

Represents a source of cluster gossip.

Instances

Show GossipSeed

Methods

showsPrec :: Int -> GossipSeed -> ShowS

show :: GossipSeed -> String

showList :: [GossipSeed] -> ShowS

gossipSeed :: String -> Int -> GossipSeed

Creates a GossipSeed.

gossipSeedWithHeader :: String -> Int -> String -> GossipSeed

Creates a GossipSeed with a specific HTTP header.

gossipSeedHost :: GossipSeed -> String

Returns GossipSeed host IP address.

gossipSeedHeader :: GossipSeed -> String

The host header to be sent when requesting gossip.

gossipSeedPort :: GossipSeed -> Int

Returns GossipSeed port.

gossipSeedClusterSettings :: NonEmpty GossipSeed -> ClusterSettings

Configures a ClusterSettings for connecting to a cluster using gossip seeds. clusterDns = "" clusterMaxDiscoverAttempts = 10 clusterExternalGossipPort = 0 clusterGossipTimeout = 1s

dnsClusterSettings :: ByteString -> ClusterSettings

Configures a ClusterSettings for connecting to a cluster using DNS discovery. clusterMaxDiscoverAttempts = 10 clusterExternalGossipPort = 0 clusterGossipSeeds = Nothing clusterGossipTimeout = 1s

Event

data Event

Contains event information like its type and data. Only used for write queries.

Instances

Eq Event

Methods

(==) :: Event -> Event -> Bool

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

Show Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

data EventData

Holds event data.

Instances

Eq EventData

Methods

(==) :: EventData -> EventData -> Bool

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

Show EventData

Methods

showsPrec :: Int -> EventData -> ShowS

show :: EventData -> String

showList :: [EventData] -> ShowS

data EventType

Constants for System event types.

Constructors

StreamDeletedType

Event type for stream deleted.

StatsCollectionType

Event type for statistics.

LinkToType

Event type for linkTo.

StreamMetadataType

Event type for stream metadata.

SettingsType

Event type for the system settings.

UserDefined Text

Event defined by the user.

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

createEvent

Arguments

:: EventType

Event type

-> Maybe UUID

Event ID, generated if Nothing

-> EventData

Event data

-> Event

Create an Event meant to be persisted.

withJson :: ToJSON a => a -> EventData

Creates an event using JSON format

withJsonAndMetadata :: (ToJSON a, ToJSON b) => a -> b -> EventData

Creates an event with metadata using JSON format.

withBinary :: ByteString -> EventData

Creates an event using a binary format.

withBinaryAndMetadata :: ByteString -> ByteString -> EventData

Creates an event with metadata using binary format.

Common Operation types

data OperationMaxAttemptReached

Occurs when an operation has been retried more than s_operationRetry.

Constructors

OperationMaxAttemptReached UUID Command

Instances

Show OperationMaxAttemptReached

Methods

showsPrec :: Int -> OperationMaxAttemptReached -> ShowS

show :: OperationMaxAttemptReached -> String

showList :: [OperationMaxAttemptReached] -> ShowS

Exception OperationMaxAttemptReached

Methods

toException :: OperationMaxAttemptReached -> SomeException

fromException :: SomeException -> Maybe OperationMaxAttemptReached

displayException :: OperationMaxAttemptReached -> String

Read Operations

data StreamMetadataResult

Represents stream metadata as a series of properties for system data and a StreamMetadata object for user metadata.

Constructors

StreamMetadataResult

Fields

• streamMetaResultStream :: !Text

  The name of the stream.

• streamMetaResultVersion :: !Int32

  The version of the metadata format.

• streamMetaResultData :: !StreamMetadata

  A StreamMetadata containing user-specified metadata.

NotFoundStreamMetadataResult

When the stream is either not found or 'no stream'.

Fields

• streamMetaResultStream :: !Text

  The name of the stream.

DeletedStreamMetadataResult

When the stream is soft-deleted.

Fields

• streamMetaResultStream :: !Text

  The name of the stream.

Instances

Show StreamMetadataResult

Methods

showsPrec :: Int -> StreamMetadataResult -> ShowS

show :: StreamMetadataResult -> String

showList :: [StreamMetadataResult] -> ShowS

readEvent

Arguments

:: Connection

-> StreamName

-> Int32

Event number

-> Bool

Resolve Link Tos

-> Maybe Credentials

-> IO (Async (ReadResult RegularStream ReadEvent))

Reads a single event from given stream.

readAllEventsBackward

Arguments

:: Connection

-> Position

-> Int32

Batch size

-> Bool

Resolve Link Tos

-> Maybe Credentials

-> IO (Async AllSlice)

Reads events from the $all stream backward

readAllEventsForward

Arguments

:: Connection

-> Position

-> Int32

Batch size

-> Bool

Resolve Link Tos

-> Maybe Credentials

-> IO (Async AllSlice)

Reads events from the $all stream forward.

readStreamEventsBackward

Arguments

:: Connection

-> StreamName

-> Int64

From event number

-> Int32

Batch size

-> Bool

Resolve Link Tos

-> Maybe Credentials

-> IO (Async (ReadResult RegularStream StreamSlice))

Reads events from a given stream backward.

readStreamEventsForward

Arguments

:: Connection

-> StreamName

-> Int64

From event number

-> Int32

Batch size

-> Bool

Resolve Link Tos

-> Maybe Credentials

-> IO (Async (ReadResult RegularStream StreamSlice))

Reads events from a given stream forward.

getStreamMetadata :: Connection -> StreamName -> Maybe Credentials -> IO (Async StreamMetadataResult)

Asynchronously gets the metadata of a stream.

Write Operations

data StreamACL

Represents an access control list for a stream.

Constructors

StreamACL

Fields

• streamACLReadRoles :: ![Text]

  Roles and users permitted to read the stream.

• streamACLWriteRoles :: ![Text]

  Roles and users permitted to write to the stream.

• streamACLDeleteRoles :: ![Text]

  Roles and users permitted to delete to the stream.

• streamACLMetaReadRoles :: ![Text]

  Roles and users permitted to read stream metadata.

• streamACLMetaWriteRoles :: ![Text]

  Roles and users permitted to write stream metadata.

Instances

Show StreamACL

Methods

showsPrec :: Int -> StreamACL -> ShowS

show :: StreamACL -> String

showList :: [StreamACL] -> ShowS

ToJSON StreamACL

Methods

toJSON :: StreamACL -> Value

toEncoding :: StreamACL -> Encoding

toJSONList :: [StreamACL] -> Value

toEncodingList :: [StreamACL] -> Encoding

FromJSON StreamACL

Methods

parseJSON :: Value -> Parser StreamACL

parseJSONList :: Value -> Parser [StreamACL]

data StreamMetadata

Represents stream metadata with strongly typed properties for system values and a dictionary-like interface for custom values.

Constructors

StreamMetadata

Fields

• streamMetadataMaxCount :: !(Maybe Int32)

  The maximum number of events allowed in the stream.

• streamMetadataMaxAge :: !(Maybe TimeSpan)

  The maximum age of events allowed in the stream.

• streamMetadataTruncateBefore :: !(Maybe Int32)

  The event number from which previous events can be scavenged. This is used to implement soft-deletion of streams.

• streamMetadataCacheControl :: !(Maybe TimeSpan)

  The amount of time for which the stream head is cachable.

• streamMetadataACL :: !StreamACL

  The access control list for the stream.

• streamMetadataCustom :: !Object

  An enumerable of key-value pairs of keys to JSON text for user-provider metadata.

Instances

Show StreamMetadata

Methods

showsPrec :: Int -> StreamMetadata -> ShowS

show :: StreamMetadata -> String

showList :: [StreamMetadata] -> ShowS

ToJSON StreamMetadata

Methods

toJSON :: StreamMetadata -> Value

toEncoding :: StreamMetadata -> Encoding

toJSONList :: [StreamMetadata] -> Value

toEncodingList :: [StreamMetadata] -> Encoding

FromJSON StreamMetadata

Methods

parseJSON :: Value -> Parser StreamMetadata

parseJSONList :: Value -> Parser [StreamMetadata]

getCustomPropertyValue :: StreamMetadata -> Text -> Maybe Value

Gets a custom property value from metadata.

getCustomProperty :: FromJSON a => StreamMetadata -> Text -> Maybe a

Get a custom property value from metadata.

emptyStreamACL :: StreamACL

StreamACL with no role or users whatsoever.

emptyStreamMetadata :: StreamMetadata

StreamMetadata with everything set to Nothing, using emptyStreamACL and an empty Object.

deleteStream

Arguments

:: Connection

-> StreamName

-> ExpectedVersion

-> Maybe Bool

Hard delete

-> Maybe Credentials

-> IO (Async DeleteResult)

Deletes given stream.

sendEvent :: Connection -> StreamName -> ExpectedVersion -> Event -> Maybe Credentials -> IO (Async WriteResult)

Sends a single Event to given stream.

sendEvents :: Connection -> StreamName -> ExpectedVersion -> [Event] -> Maybe Credentials -> IO (Async WriteResult)

Sends a list of Event to given stream.

setStreamMetadata :: Connection -> StreamName -> ExpectedVersion -> StreamMetadata -> Maybe Credentials -> IO (Async WriteResult)

Asynchronously sets the metadata for a stream.

Builder

type Builder a = Endo a

Allows to build a structure using Monoid functions.

Stream ACL Builder

type StreamACLBuilder = Builder StreamACL

A Builder applies to StreamACL.

buildStreamACL :: StreamACLBuilder -> StreamACL

Builds a StreamACL from a StreamACLBuilder.

modifyStreamACL :: StreamACLBuilder -> StreamACL -> StreamACL

Modifies a StreamACL using a StreamACLBuilder.

setReadRoles :: [Text] -> StreamACLBuilder

Sets role names with read permission for the stream.

setReadRole :: Text -> StreamACLBuilder

Sets a single role name with read permission for the stream.

setWriteRoles :: [Text] -> StreamACLBuilder

Sets role names with write permission for the stream.

setWriteRole :: Text -> StreamACLBuilder

Sets a single role name with write permission for the stream.

setDeleteRoles :: [Text] -> StreamACLBuilder

Sets role names with delete permission for the stream.

setDeleteRole :: Text -> StreamACLBuilder

Sets a single role name with delete permission for the stream.

setMetaReadRoles :: [Text] -> StreamACLBuilder

Sets role names with metadata read permission for the stream.

setMetaReadRole :: Text -> StreamACLBuilder

Sets a single role name with metadata read permission for the stream.

setMetaWriteRoles :: [Text] -> StreamACLBuilder

Sets role names with metadata write permission for the stream.

setMetaWriteRole :: Text -> StreamACLBuilder

Sets a single role name with metadata write permission for the stream.

Stream Metadata Builder

type StreamMetadataBuilder = Builder StreamMetadata

A Builder applies to StreamMetadata.

buildStreamMetadata :: StreamMetadataBuilder -> StreamMetadata

Builds a StreamMetadata from a StreamMetadataBuilder.

modifyStreamMetadata :: StreamMetadataBuilder -> StreamMetadata -> StreamMetadata

Modifies a StreamMetadata using a StreamMetadataBuilder

setMaxCount :: Int32 -> StreamMetadataBuilder

Sets the maximum number of events allowed in the stream.

setMaxAge :: TimeSpan -> StreamMetadataBuilder

Sets the maximum age of events allowed in the stream.

setTruncateBefore :: Int32 -> StreamMetadataBuilder

Sets the event number from which previous events can be scavenged.

setCacheControl :: TimeSpan -> StreamMetadataBuilder

Sets the amount of time for which the stream head is cachable.

setACL :: StreamACL -> StreamMetadataBuilder

Overwrites any previous StreamACL by the given one in a StreamMetadataBuilder.

modifyACL :: StreamACLBuilder -> StreamMetadataBuilder

Updates a StreamMetadata's StreamACL given a StreamACLBuilder.

setCustomProperty :: ToJSON a => Text -> a -> StreamMetadataBuilder

Sets a custom metadata property.

Transaction

data Transaction

Represents a multi-request transaction with the EventStore.

data TransactionId

The id of a Transaction.

Instances

Eq TransactionId

Methods

(==) :: TransactionId -> TransactionId -> Bool

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

Ord TransactionId

Methods

compare :: TransactionId -> TransactionId -> Ordering

(<) :: TransactionId -> TransactionId -> Bool

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

(>) :: TransactionId -> TransactionId -> Bool

(>=) :: TransactionId -> TransactionId -> Bool

max :: TransactionId -> TransactionId -> TransactionId

min :: TransactionId -> TransactionId -> TransactionId

Show TransactionId

Methods

showsPrec :: Int -> TransactionId -> ShowS

show :: TransactionId -> String

showList :: [TransactionId] -> ShowS

startTransaction

Arguments

:: Connection

-> StreamName

Stream name

-> ExpectedVersion

-> Maybe Credentials

-> IO (Async Transaction)

Starts a transaction on given stream.

transactionId :: Transaction -> TransactionId

Gets the id of a Transaction.

transactionCommit :: Transaction -> Maybe Credentials -> IO (Async WriteResult)

Asynchronously commits this transaction.

transactionRollback :: Transaction -> IO ()

There isn't such of thing in EventStore parlance. Basically, if you want to rollback, you just have to not transactionCommit a Transaction.

transactionWrite :: Transaction -> [Event] -> Maybe Credentials -> IO (Async ())

Asynchronously writes to a transaction in the EventStore.

Subscription

data SubscriptionClosed

Constructors

SubscriptionClosed (Maybe SubDropReason)

Instances

Show SubscriptionClosed

Methods

showsPrec :: Int -> SubscriptionClosed -> ShowS

show :: SubscriptionClosed -> String

showList :: [SubscriptionClosed] -> ShowS

Exception SubscriptionClosed

Methods

toException :: SubscriptionClosed -> SomeException

fromException :: SomeException -> Maybe SubscriptionClosed

displayException :: SubscriptionClosed -> String

data SubscriptionId

Represents a subscription id.

Instances

Eq SubscriptionId

Methods

(==) :: SubscriptionId -> SubscriptionId -> Bool

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

Ord SubscriptionId

Methods

compare :: SubscriptionId -> SubscriptionId -> Ordering

(<) :: SubscriptionId -> SubscriptionId -> Bool

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

(>) :: SubscriptionId -> SubscriptionId -> Bool

(>=) :: SubscriptionId -> SubscriptionId -> Bool

max :: SubscriptionId -> SubscriptionId -> SubscriptionId

min :: SubscriptionId -> SubscriptionId -> SubscriptionId

Show SubscriptionId

Methods

showsPrec :: Int -> SubscriptionId -> ShowS

show :: SubscriptionId -> String

showList :: [SubscriptionId] -> ShowS

class Subscription s where

Common operations supported by a subscription.

Minimal complete definition

nextEventMaybeSTM, getSubscriptionDetailsSTM, subscriptionStream, unsubscribe

Methods

nextEventMaybeSTM :: s -> STM (Maybe ResolvedEvent)

Asks for the next incoming event like nextEventMaybe while still being in the the STM.

getSubscriptionDetailsSTM :: s -> STM SubDetails

Returns the runtime details of a subscription.

subscriptionStream :: s -> StreamName

Get subscription stream.

unsubscribe :: s -> IO ()

Asynchronously unsubscribe from the the stream.

Instances

Subscription RegularSubscription

Methods

nextEventMaybeSTM :: RegularSubscription -> STM (Maybe ResolvedEvent)

getSubscriptionDetailsSTM :: RegularSubscription -> STM SubDetails

subscriptionStream :: RegularSubscription -> StreamName

unsubscribe :: RegularSubscription -> IO ()

Subscription PersistentSubscription

Methods

nextEventMaybeSTM :: PersistentSubscription -> STM (Maybe ResolvedEvent)

getSubscriptionDetailsSTM :: PersistentSubscription -> STM SubDetails

subscriptionStream :: PersistentSubscription -> StreamName

unsubscribe :: PersistentSubscription -> IO ()

Subscription CatchupSubscription

Methods

nextEventMaybeSTM :: CatchupSubscription -> STM (Maybe ResolvedEvent)

getSubscriptionDetailsSTM :: CatchupSubscription -> STM SubDetails

subscriptionStream :: CatchupSubscription -> StreamName

unsubscribe :: CatchupSubscription -> IO ()

data SubDropReason

Indicates why a subscription has been dropped.

Constructors

SubUnsubscribed

Subscription connection has been closed by the user.

SubAccessDenied

The current user is not allowed to operate on the supplied stream.

SubNotFound

Given stream name doesn't exist.

SubPersistDeleted

Given stream is deleted.

SubAborted

Occurs when the user shutdown the connection from the server or if the connection to the server is no longer possible.

SubNotAuthenticated (Maybe Text)

SubServerError (Maybe Text)

Unexpected error from the server.

SubNotHandled !NotHandledReason !(Maybe MasterInfo)

SubClientError !Text

SubSubscriberMaxCountReached

Instances

Eq SubDropReason

Methods

(==) :: SubDropReason -> SubDropReason -> Bool

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

Show SubDropReason

Methods

showsPrec :: Int -> SubDropReason -> ShowS

show :: SubDropReason -> String

showList :: [SubDropReason] -> ShowS

data SubDetails

Subscription runtime details. Not useful for the user but at least it makes Haddock documentation generation less ugly.

waitConfirmation :: Subscription s => s -> IO ()

Waits until the Subscription has been confirmed.

unsubscribeConfirmed :: Subscription s => s -> IO Bool

Non blocking version of waitUnsubscribeConfirmed.

unsubscribeConfirmedSTM :: Subscription s => s -> STM Bool

Like unsubscribeConfirmed but lives in STM monad.

waitUnsubscribeConfirmed :: Subscription s => s -> IO ()

Wait until unsubscription has been confirmed by the server.

nextEventMaybeSTM :: Subscription s => s -> STM (Maybe ResolvedEvent)

Asks for the next incoming event like nextEventMaybe while still being in the the STM.

getSubscriptionDetailsSTM :: Subscription s => s -> STM SubDetails

Returns the runtime details of a subscription.

unsubscribe :: Subscription s => s -> IO ()

Asynchronously unsubscribe from the the stream.

subscriptionStream :: Subscription s => s -> StreamName

Get subscription stream.

Volatile Subscription

data RegularSubscription

Also referred as volatile subscription. For example, if a stream has 100 events in it when a subscriber connects, the subscriber can expect to see event number 101 onwards until the time the subscription is closed or dropped.

Instances

Subscription RegularSubscription

Methods

nextEventMaybeSTM :: RegularSubscription -> STM (Maybe ResolvedEvent)

getSubscriptionDetailsSTM :: RegularSubscription -> STM SubDetails

subscriptionStream :: RegularSubscription -> StreamName

unsubscribe :: RegularSubscription -> IO ()

subscribe

Arguments

:: Connection

-> StreamName

-> Bool

Resolve Link Tos

-> Maybe Credentials

-> IO RegularSubscription

Subcribes to given stream.

subscribeToAll

Arguments

:: Connection

-> Bool

Resolve Link Tos

-> Maybe Credentials

-> IO RegularSubscription

Subcribes to $all stream.

getSubscriptionId :: Subscription s => s -> IO SubscriptionId

Gets the ID of the subscription.

isSubscribedToAll :: Subscription s => s -> Bool

If the subscription is on the $all stream.

nextEvent :: Subscription s => s -> IO ResolvedEvent

Awaits for the next event.

nextEventMaybe :: Subscription s => s -> IO (Maybe ResolvedEvent)

Non blocking version of nextEvent.

Catch-up Subscription

data CatchupSubscription

This kind of subscription specifies a starting point, in the form of an event number or transaction file position. The given function will be called for events from the starting point until the end of the stream, and then for subsequently written events.

For example, if a starting point of 50 is specified when a stream has 100 events in it, the subscriber can expect to see events 51 through 100, and then any events subsequently written until such time as the subscription is dropped or closed.

Instances

Subscription CatchupSubscription

Methods

nextEventMaybeSTM :: CatchupSubscription -> STM (Maybe ResolvedEvent)

getSubscriptionDetailsSTM :: CatchupSubscription -> STM SubDetails

subscriptionStream :: CatchupSubscription -> StreamName

unsubscribe :: CatchupSubscription -> IO ()

subscribeFrom

Arguments

:: Connection

-> StreamName

-> Bool

Resolve Link Tos

-> Maybe Int64

Last checkpoint

-> Maybe Int32

Batch size

-> Maybe Credentials

-> IO CatchupSubscription

Subscribes to given stream. If last checkpoint is defined, this will readStreamEventsForward from that event number, otherwise from the beginning. Once last stream event reached up, a subscription request will be sent using subscribe.

subscribeToAllFrom

Arguments

:: Connection

-> Bool

Resolve Link Tos

-> Maybe Position

Last checkpoint

-> Maybe Int32

Batch size

-> Maybe Credentials

-> IO CatchupSubscription

Same as subscribeFrom but applied to $all stream.

waitTillCatchup :: CatchupSubscription -> IO ()

Waits until CatchupSubscription subscription catch-up its stream.

hasCaughtUp :: CatchupSubscription -> IO Bool

Non blocking version of waitTillCatchup.

hasCaughtUpSTM :: CatchupSubscription -> STM Bool

Like hasCaughtUp but lives in STM monad.

Persistent Subscription

data PersistentSubscription

The server remembers the state of the subscription. This allows for many different modes of operations compared to a regular or catchup subscription where the client holds the subscription state. (Need EventStore >= v3.1.0).

Instances

Subscription PersistentSubscription

Methods

nextEventMaybeSTM :: PersistentSubscription -> STM (Maybe ResolvedEvent)

getSubscriptionDetailsSTM :: PersistentSubscription -> STM SubDetails

subscriptionStream :: PersistentSubscription -> StreamName

unsubscribe :: PersistentSubscription -> IO ()

data PersistentSubscriptionSettings

Gathers every persistent subscription property.

Constructors

PersistentSubscriptionSettings

Fields

• psSettingsResolveLinkTos :: !Bool

  Whether or not the persistent subscription should resolve linkTo events to their linked events.

• psSettingsStartFrom :: !Int64

  Where the subscription should start from (position).

• psSettingsExtraStats :: !Bool

  Whether or not in depth latency statistics should be tracked on this subscription.

• psSettingsMsgTimeout :: !TimeSpan

  The amount of time after which a message should be considered to be timeout and retried.

• psSettingsMaxRetryCount :: !Int32

  The maximum number of retries (due to timeout) before a message get considered to be parked.

• psSettingsLiveBufSize :: !Int32

  The size of the buffer listening to live messages as they happen.

• psSettingsReadBatchSize :: !Int32

  The number of events read at a time when paging in history.

• psSettingsHistoryBufSize :: !Int32

  The number of events to cache when paging through history.

• psSettingsCheckPointAfter :: !TimeSpan

  The amount of time to try checkpoint after.

• psSettingsMinCheckPointCount :: !Int32

  The minimum number of messages to checkpoint.

• psSettingsMaxCheckPointCount :: !Int32

  The maximum number of message to checkpoint. If this number is reached, a checkpoint will be forced.

• psSettingsMaxSubsCount :: !Int32

  The maximum number of subscribers allowed.

• psSettingsNamedConsumerStrategy :: !SystemConsumerStrategy

  The strategy to use for distributing events to client consumers.

Instances

Eq PersistentSubscriptionSettings

Methods

(==) :: PersistentSubscriptionSettings -> PersistentSubscriptionSettings -> Bool

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

Show PersistentSubscriptionSettings

Methods

showsPrec :: Int -> PersistentSubscriptionSettings -> ShowS

show :: PersistentSubscriptionSettings -> String

showList :: [PersistentSubscriptionSettings] -> ShowS

data SystemConsumerStrategy

System supported consumer strategies for use with persistent subscriptions.

Constructors

DispatchToSingle

Distributes events to a single client until it is full. Then round robin to the next client.

RoundRobin

Distributes events to each client in a round robin fashion.

Instances

Eq SystemConsumerStrategy

Methods

(==) :: SystemConsumerStrategy -> SystemConsumerStrategy -> Bool

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

Show SystemConsumerStrategy

Methods

showsPrec :: Int -> SystemConsumerStrategy -> ShowS

show :: SystemConsumerStrategy -> String

showList :: [SystemConsumerStrategy] -> ShowS

data NakAction

Gathers every possible Nak actions.

Constructors

NA_Unknown

NA_Park

NA_Retry

NA_Skip

NA_Stop

Instances

Enum NakAction

Methods

succ :: NakAction -> NakAction

pred :: NakAction -> NakAction

toEnum :: Int -> NakAction

fromEnum :: NakAction -> Int

enumFrom :: NakAction -> [NakAction]

enumFromThen :: NakAction -> NakAction -> [NakAction]

enumFromTo :: NakAction -> NakAction -> [NakAction]

enumFromThenTo :: NakAction -> NakAction -> NakAction -> [NakAction]

Eq NakAction

Methods

(==) :: NakAction -> NakAction -> Bool

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

Show NakAction

Methods

showsPrec :: Int -> NakAction -> ShowS

show :: NakAction -> String

showList :: [NakAction] -> ShowS

data PersistActionException

Enumerates all persistent action exceptions.

Constructors

PersistActionFail

The action failed.

PersistActionAlreadyExist

Happens when creating a persistent subscription on a stream with a group name already taken.

PersistActionDoesNotExist

An operation tried to do something on a persistent subscription or a stream that don't exist.

PersistActionAccessDenied

The current user is not allowed to operate on the supplied stream or persistent subscription.

PersistActionAborted

That action has been aborted because the user shutdown the connection to the server or the connection to the server is no longer possible.

Instances

Show PersistActionException

Methods

showsPrec :: Int -> PersistActionException -> ShowS

show :: PersistActionException -> String

showList :: [PersistActionException] -> ShowS

Exception PersistActionException

Methods

toException :: PersistActionException -> SomeException

fromException :: SomeException -> Maybe PersistActionException

displayException :: PersistActionException -> String

acknowledge :: PersistentSubscription -> ResolvedEvent -> IO ()

Acknowledges that ResolvedEvent has been successfully processed.

acknowledgeEvents :: PersistentSubscription -> [ResolvedEvent] -> IO ()

Acknowledges those ResolvedEvents have been successfully processed.

failed :: PersistentSubscription -> ResolvedEvent -> NakAction -> Maybe Text -> IO ()

Mark a message that has failed processing. The server will take action based upon the action parameter.

eventsFailed :: PersistentSubscription -> [ResolvedEvent] -> NakAction -> Maybe Text -> IO ()

Mark messages that have failed processing. The server will take action based upon the action parameter.

notifyEventsProcessed :: PersistentSubscription -> [UUID] -> IO ()

Acknowledges those event ids have been successfully processed.

notifyEventsFailed :: PersistentSubscription -> NakAction -> Maybe Text -> [UUID] -> IO ()

Acknowledges those event ids have failed to be processed successfully.

defaultPersistentSubscriptionSettings :: PersistentSubscriptionSettings

System default persistent subscription settings.

createPersistentSubscription :: Connection -> Text -> StreamName -> PersistentSubscriptionSettings -> Maybe Credentials -> IO (Async (Maybe PersistActionException))

Asynchronously create a persistent subscription group on a stream.

updatePersistentSubscription :: Connection -> Text -> StreamName -> PersistentSubscriptionSettings -> Maybe Credentials -> IO (Async (Maybe PersistActionException))

Asynchronously update a persistent subscription group on a stream.

deletePersistentSubscription :: Connection -> Text -> StreamName -> Maybe Credentials -> IO (Async (Maybe PersistActionException))

Asynchronously delete a persistent subscription group on a stream.

connectToPersistentSubscription :: Connection -> Text -> StreamName -> Int32 -> Maybe Credentials -> IO PersistentSubscription

Asynchronously connect to a persistent subscription given a group on a stream.

Results

class Slice a where

Gathers common slice operations.

Minimal complete definition

sliceEvents, sliceDirection, sliceEOS, sliceFrom, sliceNext, toSlice

Associated Types

type Loc a

Methods

sliceEvents :: a -> [ResolvedEvent]

Gets slice's ResolvedEvents.

sliceDirection :: a -> ReadDirection

Gets slice's reading direction.

sliceEOS :: a -> Bool

If the slice reaches the end of the stream.

sliceFrom :: a -> Loc a

Gets the starting location of this slice.

sliceNext :: a -> Loc a

Gets the next location of this slice.

toSlice :: a -> SomeSlice

Returns a common view of a slice.

Instances

Slice AllSlice

Associated Types

type Loc AllSlice :: *

Methods

sliceEvents :: AllSlice -> [ResolvedEvent]

sliceDirection :: AllSlice -> ReadDirection

sliceEOS :: AllSlice -> Bool

sliceFrom :: AllSlice -> Loc AllSlice

sliceNext :: AllSlice -> Loc AllSlice

toSlice :: AllSlice -> SomeSlice

Slice StreamSlice

Associated Types

type Loc StreamSlice :: *

Methods

sliceEvents :: StreamSlice -> [ResolvedEvent]

sliceDirection :: StreamSlice -> ReadDirection

sliceEOS :: StreamSlice -> Bool

sliceFrom :: StreamSlice -> Loc StreamSlice

sliceNext :: StreamSlice -> Loc StreamSlice

toSlice :: StreamSlice -> SomeSlice

data AllSlice

Represents a slice of the $all stream.

Instances

Show AllSlice

Methods

showsPrec :: Int -> AllSlice -> ShowS

show :: AllSlice -> String

showList :: [AllSlice] -> ShowS

Slice AllSlice

Associated Types

type Loc AllSlice :: *

Methods

sliceEvents :: AllSlice -> [ResolvedEvent]

sliceDirection :: AllSlice -> ReadDirection

sliceEOS :: AllSlice -> Bool

sliceFrom :: AllSlice -> Loc AllSlice

sliceNext :: AllSlice -> Loc AllSlice

toSlice :: AllSlice -> SomeSlice

type Loc AllSlice

type Loc AllSlice = Position

newtype DeleteResult

Returned after deleting a stream. Position of the write.

Constructors

DeleteResult Position

Instances

Eq DeleteResult

Methods

(==) :: DeleteResult -> DeleteResult -> Bool

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

Show DeleteResult

Methods

showsPrec :: Int -> DeleteResult -> ShowS

show :: DeleteResult -> String

showList :: [DeleteResult] -> ShowS

data WriteResult

Returned after writing to a stream.

Constructors

WriteResult

Fields

• writeNextExpectedVersion :: !Int64

  Next expected version of the stream.

• writePosition :: !Position

  Position of the write.

Instances

Eq WriteResult

Methods

(==) :: WriteResult -> WriteResult -> Bool

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

Show WriteResult

Methods

showsPrec :: Int -> WriteResult -> ShowS

show :: WriteResult -> String

showList :: [WriteResult] -> ShowS

data ReadResult :: StreamType -> * -> * where

Enumeration detailing the possible outcomes of reading a stream.

Constructors

ReadSuccess :: a -> ReadResult t a

ReadNoStream :: ReadResult RegularStream a

ReadStreamDeleted :: Text -> ReadResult RegularStream a

ReadNotModified :: ReadResult t a

ReadError :: Maybe Text -> ReadResult t a

ReadAccessDenied :: StreamName -> ReadResult t a

Instances

Functor (ReadResult t)

Methods

fmap :: (a -> b) -> ReadResult t a -> ReadResult t b

(<$) :: a -> ReadResult t b -> ReadResult t a

Foldable (ReadResult t)

Methods

fold :: Monoid m => ReadResult t m -> m

foldMap :: Monoid m => (a -> m) -> ReadResult t a -> m

foldr :: (a -> b -> b) -> b -> ReadResult t a -> b

foldr' :: (a -> b -> b) -> b -> ReadResult t a -> b

foldl :: (b -> a -> b) -> b -> ReadResult t a -> b

foldl' :: (b -> a -> b) -> b -> ReadResult t a -> b

foldr1 :: (a -> a -> a) -> ReadResult t a -> a

foldl1 :: (a -> a -> a) -> ReadResult t a -> a

toList :: ReadResult t a -> [a]

null :: ReadResult t a -> Bool

length :: ReadResult t a -> Int

elem :: Eq a => a -> ReadResult t a -> Bool

maximum :: Ord a => ReadResult t a -> a

minimum :: Ord a => ReadResult t a -> a

sum :: Num a => ReadResult t a -> a

product :: Num a => ReadResult t a -> a

Traversable (ReadResult t)

Methods

traverse :: Applicative f => (a -> f b) -> ReadResult t a -> f (ReadResult t b)

sequenceA :: Applicative f => ReadResult t (f a) -> f (ReadResult t a)

mapM :: Monad m => (a -> m b) -> ReadResult t a -> m (ReadResult t b)

sequence :: Monad m => ReadResult t (m a) -> m (ReadResult t a)

Eq a => Eq (ReadResult t a)

Methods

(==) :: ReadResult t a -> ReadResult t a -> Bool

(/=) :: ReadResult t a -> ReadResult t a -> Bool

Show a => Show (ReadResult t a)

Methods

showsPrec :: Int -> ReadResult t a -> ShowS

show :: ReadResult t a -> String

showList :: [ReadResult t a] -> ShowS

data RecordedEvent

Represents a previously written event.

Constructors

RecordedEvent

Fields

• recordedEventStreamId :: !Text

  The event stream that this event belongs to.

• recordedEventId :: !UUID

  Unique identifier representing this event.

• recordedEventNumber :: !Int64

  Number of this event in the stream.

• recordedEventType :: !Text

  Type of this event.

• recordedEventData :: !ByteString

  Representing the data of this event.

• recordedEventMetadata :: !(Maybe ByteString)

  Representing the metadada associated with this event.

• recordedEventIsJson :: !Bool

  Indicates whether the content is internally marked as json.

• recordedEventCreated :: !(Maybe UTCTime)

  Representing when this event was created in the system.

Instances

Show RecordedEvent

Methods

showsPrec :: Int -> RecordedEvent -> ShowS

show :: RecordedEvent -> String

showList :: [RecordedEvent] -> ShowS

data ReadEvent

Represents the result of looking up a specific event number from a stream.

Constructors

ReadEventNotFound

Fields

• readEventStream :: !Text
• readEventNumber :: !Int32

ReadEvent

Fields

• readEventStream :: !Text
• readEventNumber :: !Int32
• readEventResolved :: !ResolvedEvent

Instances

Show ReadEvent

Methods

showsPrec :: Int -> ReadEvent -> ShowS

show :: ReadEvent -> String

showList :: [ReadEvent] -> ShowS

data StreamType

A stream can either point to $all or a regular one.

Constructors

All

RegularStream

Instances

Eq StreamType

Methods

(==) :: StreamType -> StreamType -> Bool

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

Ord StreamType

Methods

compare :: StreamType -> StreamType -> Ordering

(<) :: StreamType -> StreamType -> Bool

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

(>) :: StreamType -> StreamType -> Bool

(>=) :: StreamType -> StreamType -> Bool

max :: StreamType -> StreamType -> StreamType

min :: StreamType -> StreamType -> StreamType

data StreamSlice

Regular stream slice.

Instances

Show StreamSlice

Methods

showsPrec :: Int -> StreamSlice -> ShowS

show :: StreamSlice -> String

showList :: [StreamSlice] -> ShowS

Slice StreamSlice

Associated Types

type Loc StreamSlice :: *

Methods

sliceEvents :: StreamSlice -> [ResolvedEvent]

sliceDirection :: StreamSlice -> ReadDirection

sliceEOS :: StreamSlice -> Bool

sliceFrom :: StreamSlice -> Loc StreamSlice

sliceNext :: StreamSlice -> Loc StreamSlice

toSlice :: StreamSlice -> SomeSlice

type Loc StreamSlice

type Loc StreamSlice = Int64

data Position

A structure referring to a potential logical record position in the EventStore transaction file.

Constructors

Position

Fields

• positionCommit :: !Int64

  Commit position of the record

• positionPrepare :: !Int64

  Prepare position of the record

Instances

Eq Position

Methods

(==) :: Position -> Position -> Bool

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

Ord Position

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

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

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

Show Position

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

data ReadDirection

Represents the direction of read operation (both from $all an usual streams).

Constructors

Forward

From beginning to end

Backward

From end to beginning

Instances

Eq ReadDirection

Methods

(==) :: ReadDirection -> ReadDirection -> Bool

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

Show ReadDirection

Methods

showsPrec :: Int -> ReadDirection -> ShowS

show :: ReadDirection -> String

showList :: [ReadDirection] -> ShowS

data ResolvedEvent

A structure representing a single event or an resolved link event.

Constructors

ResolvedEvent

Fields

• resolvedEventRecord :: !(Maybe RecordedEvent)

  The event, or the resolved link event if this ResolvedEvent is a link event.

• resolvedEventLink :: !(Maybe RecordedEvent)

  The link event if this ResolvedEvent is a link event.

• resolvedEventPosition :: !(Maybe Position)

  Possible Position of that event.

Instances

Show ResolvedEvent

Methods

showsPrec :: Int -> ResolvedEvent -> ShowS

show :: ResolvedEvent -> String

showList :: [ResolvedEvent] -> ShowS

data OperationError

Operation exception that can occurs on an operation response.

Constructors

WrongExpectedVersion Text ExpectedVersion

Stream and Expected Version

StreamDeleted Text

Stream

InvalidTransaction

AccessDenied StreamName

Stream

InvalidServerResponse Command Command

Expected, Found

ProtobufDecodingError String

ServerError (Maybe Text)

Reason

InvalidOperation Text

StreamNotFound Text

NotAuthenticatedOp

Invalid operation state. If happens, it's a driver bug.

Aborted

Occurs when the user asked to close the connection or if the connection can't reconnect anymore.

Instances

Show OperationError

Methods

showsPrec :: Int -> OperationError -> ShowS

show :: OperationError -> String

showList :: [OperationError] -> ShowS

Exception OperationError

Methods

toException :: OperationError -> SomeException

fromException :: SomeException -> Maybe OperationError

displayException :: OperationError -> String

data StreamName

Represents a regular stream name or $all stream.

Constructors

StreamName Text

AllStream

Instances

Eq StreamName

Methods

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

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

Show StreamName

Methods

showsPrec :: Int -> StreamName -> ShowS

show :: StreamName -> String

showList :: [StreamName] -> ShowS

IsString StreamName

Methods

fromString :: String -> StreamName

isEventResolvedLink :: ResolvedEvent -> Bool

Indicates whether this ResolvedEvent is a resolved link event.

resolvedEventOriginal :: ResolvedEvent -> RecordedEvent

Returns the event that was read or which triggered the subscription.

If this ResolvedEvent represents a link event, the link will be the original event, otherwise it will be the event.

resolvedEventDataAsJson :: FromJSON a => ResolvedEvent -> Maybe a

Tries to desarialize resolvedEventOriginal data as JSON.

resolvedEventOriginalStreamId :: ResolvedEvent -> Text

The stream name of the original event.

resolvedEventOriginalId :: ResolvedEvent -> UUID

The ID of the original event.

resolvedEventOriginalEventNumber :: ResolvedEvent -> Int64

The event number of the original event.

recordedEventDataAsJson :: FromJSON a => RecordedEvent -> Maybe a

Tries to parse JSON object from the given RecordedEvent.

positionStart :: Position

Representing the start of the transaction file.

positionEnd :: Position

Representing the end of the transaction file.

Logging

data LogLevel :: *

Constructors

LevelDebug

LevelInfo

LevelWarn

LevelError

LevelOther Text

Instances

Eq LogLevel

Methods

(==) :: LogLevel -> LogLevel -> Bool

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

Ord LogLevel

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

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

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel

Read LogLevel

Methods

readsPrec :: Int -> ReadS LogLevel

readList :: ReadS [LogLevel]

readPrec :: ReadPrec LogLevel

readListPrec :: ReadPrec [LogLevel]

Show LogLevel

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Lift LogLevel

Methods

lift :: LogLevel -> Q Exp

data LogType :: *

Logger Type.

Constructors

LogNone

No logging.

LogStdout BufSize

Logging to stdout. BufSize is a buffer size for each capability.

LogStderr BufSize

Logging to stderr. BufSize is a buffer size for each capability.

LogFileNoRotate FilePath BufSize

Logging to a file. BufSize is a buffer size for each capability.

LogFile FileLogSpec BufSize

Logging to a file. BufSize is a buffer size for each capability. File rotation is done on-demand.

LogCallback (LogStr -> IO ()) (IO ())

Logging with a log and flush action. run flush after log each message.

data LoggerFilter

Constructors

LoggerFilter (LogSource -> LogLevel -> Bool)

LoggerLevel LogLevel

Misc

data Command

Internal command representation.

Instances

Eq Command

Methods

(==) :: Command -> Command -> Bool

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

Ord Command

Methods

compare :: Command -> Command -> Ordering

(<) :: Command -> Command -> Bool

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

(>) :: Command -> Command -> Bool

(>=) :: Command -> Command -> Bool

max :: Command -> Command -> Command

min :: Command -> Command -> Command

Show Command

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

data DropReason

Represents the reason subscription drop happened.

Constructors

D_Unsubscribed

D_AccessDenied

D_NotFound

D_PersistentSubscriptionDeleted

D_SubscriberMaxCountReached

Instances

Enum DropReason

Methods

succ :: DropReason -> DropReason

pred :: DropReason -> DropReason

toEnum :: Int -> DropReason

fromEnum :: DropReason -> Int

enumFrom :: DropReason -> [DropReason]

enumFromThen :: DropReason -> DropReason -> [DropReason]

enumFromTo :: DropReason -> DropReason -> [DropReason]

enumFromThenTo :: DropReason -> DropReason -> DropReason -> [DropReason]

Eq DropReason

Methods

(==) :: DropReason -> DropReason -> Bool

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

Show DropReason

Methods

showsPrec :: Int -> DropReason -> ShowS

show :: DropReason -> String

showList :: [DropReason] -> ShowS

data ExpectedVersion

Constants used for expected version control.

The use of expected version can be a bit tricky especially when discussing idempotency assurances given by the EventStore.

The EventStore will assure idempotency for all operations using any value in ExpectedVersion except for anyStream. When using anyStream the EventStore will do its best to assure idempotency but will not guarantee idempotency.

Instances

Eq ExpectedVersion

Methods

(==) :: ExpectedVersion -> ExpectedVersion -> Bool

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

Show ExpectedVersion

Methods

showsPrec :: Int -> ExpectedVersion -> ShowS

show :: ExpectedVersion -> String

showList :: [ExpectedVersion] -> ShowS

anyVersion :: ExpectedVersion

This write should not conflict with anything and should always succeed.

noStreamVersion :: ExpectedVersion

The stream being written to should not yet exist. If it does exist treat that as a concurrency problem.

emptyStreamVersion :: ExpectedVersion

The stream should exist and should be empty. If it does not exist or is not empty, treat that as a concurrency problem.

exactEventVersion :: Int64 -> ExpectedVersion

States that the last event written to the stream should have a sequence number matching your expected value.

streamExists :: ExpectedVersion

The stream should exist. If it or a metadata stream does not exist treat that as a concurrency problem.

msDiffTime :: Float -> NominalDiffTime

Millisecond timespan

Re-export

(<>) :: Semigroup a => a -> a -> a infixr 6

An associative operation.

(a <> b) <> c = a <> (b <> c)

If a is also a Monoid we further require

(<>) = mappend

data NonEmpty a :: * -> *

Non-empty (and non-strict) list type.

Since: 4.9.0.0

Constructors

a :| [a] infixr 5

Instances

Monad NonEmpty

Since: 4.9.0.0

Methods

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

(>>) :: NonEmpty a -> NonEmpty b -> NonEmpty b

return :: a -> NonEmpty a

fail :: String -> NonEmpty a

Functor NonEmpty

Since: 4.9.0.0

Methods

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

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

MonadFix NonEmpty

Since: 4.9.0.0

Methods

mfix :: (a -> NonEmpty a) -> NonEmpty a

Applicative NonEmpty

Since: 4.9.0.0

Methods

pure :: a -> NonEmpty a

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

liftA2 :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c

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

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

Foldable NonEmpty

Since: 4.9.0.0

Methods

fold :: Monoid m => NonEmpty m -> m

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

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

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

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

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

foldr1 :: (a -> a -> a) -> NonEmpty a -> a

foldl1 :: (a -> a -> a) -> NonEmpty a -> a

toList :: NonEmpty a -> [a]

null :: NonEmpty a -> Bool

length :: NonEmpty a -> Int

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

maximum :: Ord a => NonEmpty a -> a

minimum :: Ord a => NonEmpty a -> a

sum :: Num a => NonEmpty a -> a

product :: Num a => NonEmpty a -> a

Traversable NonEmpty

Since: 4.9.0.0

Methods

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

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

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

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

ToJSON1 NonEmpty

Methods

liftToJSON :: (a -> Value) -> ([a] -> Value) -> NonEmpty a -> Value

liftToJSONList :: (a -> Value) -> ([a] -> Value) -> [NonEmpty a] -> Value

liftToEncoding :: (a -> Encoding) -> ([a] -> Encoding) -> NonEmpty a -> Encoding

liftToEncodingList :: (a -> Encoding) -> ([a] -> Encoding) -> [NonEmpty a] -> Encoding

FromJSON1 NonEmpty

Methods

liftParseJSON :: (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (NonEmpty a)

liftParseJSONList :: (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser [NonEmpty a]

Eq1 NonEmpty

Since: 4.10.0.0

Methods

liftEq :: (a -> b -> Bool) -> NonEmpty a -> NonEmpty b -> Bool

Ord1 NonEmpty

Since: 4.10.0.0

Methods

liftCompare :: (a -> b -> Ordering) -> NonEmpty a -> NonEmpty b -> Ordering

Read1 NonEmpty

Since: 4.10.0.0

Methods

liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (NonEmpty a)

liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [NonEmpty a]

liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (NonEmpty a)

liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [NonEmpty a]

Show1 NonEmpty

Since: 4.10.0.0

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> NonEmpty a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [NonEmpty a] -> ShowS

MonadZip NonEmpty

Since: 4.9.0.0

Methods

mzip :: NonEmpty a -> NonEmpty b -> NonEmpty (a, b)

mzipWith :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c

munzip :: NonEmpty (a, b) -> (NonEmpty a, NonEmpty b)

Cosieve Mealy NonEmpty

Methods

cosieve :: Mealy a b -> NonEmpty a -> b

IsList (NonEmpty a)

Since: 4.9.0.0

Associated Types

type Item (NonEmpty a) :: *

Methods

fromList :: [Item (NonEmpty a)] -> NonEmpty a

fromListN :: Int -> [Item (NonEmpty a)] -> NonEmpty a

toList :: NonEmpty a -> [Item (NonEmpty a)]

Eq a => Eq (NonEmpty a)

Methods

(==) :: NonEmpty a -> NonEmpty a -> Bool

(/=) :: NonEmpty a -> NonEmpty a -> Bool

Data a => Data (NonEmpty a)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NonEmpty a -> c (NonEmpty a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (NonEmpty a)

toConstr :: NonEmpty a -> Constr

dataTypeOf :: NonEmpty a -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (NonEmpty a))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (NonEmpty a))

gmapT :: (forall b. Data b => b -> b) -> NonEmpty a -> NonEmpty a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NonEmpty a -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NonEmpty a -> r

gmapQ :: (forall d. Data d => d -> u) -> NonEmpty a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> NonEmpty a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NonEmpty a -> m (NonEmpty a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NonEmpty a -> m (NonEmpty a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NonEmpty a -> m (NonEmpty a)

Ord a => Ord (NonEmpty a)

Methods

compare :: NonEmpty a -> NonEmpty a -> Ordering

(<) :: NonEmpty a -> NonEmpty a -> Bool

(<=) :: NonEmpty a -> NonEmpty a -> Bool

(>) :: NonEmpty a -> NonEmpty a -> Bool

(>=) :: NonEmpty a -> NonEmpty a -> Bool

max :: NonEmpty a -> NonEmpty a -> NonEmpty a

min :: NonEmpty a -> NonEmpty a -> NonEmpty a

Read a => Read (NonEmpty a)

Methods

readsPrec :: Int -> ReadS (NonEmpty a)

readList :: ReadS [NonEmpty a]

readPrec :: ReadPrec (NonEmpty a)

readListPrec :: ReadPrec [NonEmpty a]

Show a => Show (NonEmpty a)

Methods

showsPrec :: Int -> NonEmpty a -> ShowS

show :: NonEmpty a -> String

showList :: [NonEmpty a] -> ShowS

Generic (NonEmpty a)

Associated Types

type Rep (NonEmpty a) :: * -> *

Methods

from :: NonEmpty a -> Rep (NonEmpty a) x

to :: Rep (NonEmpty a) x -> NonEmpty a

Semigroup (NonEmpty a)

Since: 4.9.0.0

Methods

(<>) :: NonEmpty a -> NonEmpty a -> NonEmpty a

sconcat :: NonEmpty (NonEmpty a) -> NonEmpty a

stimes :: Integral b => b -> NonEmpty a -> NonEmpty a

Hashable a => Hashable (NonEmpty a)

Methods

hashWithSalt :: Int -> NonEmpty a -> Int

hash :: NonEmpty a -> Int

ToJSON a => ToJSON (NonEmpty a)

Methods

toJSON :: NonEmpty a -> Value

toEncoding :: NonEmpty a -> Encoding

toJSONList :: [NonEmpty a] -> Value

toEncodingList :: [NonEmpty a] -> Encoding

FromJSON a => FromJSON (NonEmpty a)

Methods

parseJSON :: Value -> Parser (NonEmpty a)

parseJSONList :: Value -> Parser [NonEmpty a]

SemiSequence (NonEmpty a)

Associated Types

type Index (NonEmpty a) :: *

Methods

intersperse :: Element (NonEmpty a) -> NonEmpty a -> NonEmpty a

reverse :: NonEmpty a -> NonEmpty a

find :: (Element (NonEmpty a) -> Bool) -> NonEmpty a -> Maybe (Element (NonEmpty a))

sortBy :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Ordering) -> NonEmpty a -> NonEmpty a

cons :: Element (NonEmpty a) -> NonEmpty a -> NonEmpty a

snoc :: NonEmpty a -> Element (NonEmpty a) -> NonEmpty a

MonoFunctor (NonEmpty a)

Methods

omap :: (Element (NonEmpty a) -> Element (NonEmpty a)) -> NonEmpty a -> NonEmpty a

MonoFoldable (NonEmpty a)

Methods

ofoldMap :: Monoid m => (Element (NonEmpty a) -> m) -> NonEmpty a -> m

ofoldr :: (Element (NonEmpty a) -> b -> b) -> b -> NonEmpty a -> b

ofoldl' :: (a -> Element (NonEmpty a) -> a) -> a -> NonEmpty a -> a

otoList :: NonEmpty a -> [Element (NonEmpty a)]

oall :: (Element (NonEmpty a) -> Bool) -> NonEmpty a -> Bool

oany :: (Element (NonEmpty a) -> Bool) -> NonEmpty a -> Bool

onull :: NonEmpty a -> Bool

olength :: NonEmpty a -> Int

olength64 :: NonEmpty a -> Int64

ocompareLength :: Integral i => NonEmpty a -> i -> Ordering

otraverse_ :: Applicative f => (Element (NonEmpty a) -> f b) -> NonEmpty a -> f ()

ofor_ :: Applicative f => NonEmpty a -> (Element (NonEmpty a) -> f b) -> f ()

omapM_ :: Applicative m => (Element (NonEmpty a) -> m ()) -> NonEmpty a -> m ()

oforM_ :: Applicative m => NonEmpty a -> (Element (NonEmpty a) -> m ()) -> m ()

ofoldlM :: Monad m => (a -> Element (NonEmpty a) -> m a) -> a -> NonEmpty a -> m a

ofoldMap1Ex :: Semigroup m => (Element (NonEmpty a) -> m) -> NonEmpty a -> m

ofoldr1Ex :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Element (NonEmpty a)) -> NonEmpty a -> Element (NonEmpty a)

ofoldl1Ex' :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Element (NonEmpty a)) -> NonEmpty a -> Element (NonEmpty a)

headEx :: NonEmpty a -> Element (NonEmpty a)

lastEx :: NonEmpty a -> Element (NonEmpty a)

unsafeHead :: NonEmpty a -> Element (NonEmpty a)

unsafeLast :: NonEmpty a -> Element (NonEmpty a)

maximumByEx :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Ordering) -> NonEmpty a -> Element (NonEmpty a)

minimumByEx :: (Element (NonEmpty a) -> Element (NonEmpty a) -> Ordering) -> NonEmpty a -> Element (NonEmpty a)

oelem :: Element (NonEmpty a) -> NonEmpty a -> Bool

onotElem :: Element (NonEmpty a) -> NonEmpty a -> Bool

MonoTraversable (NonEmpty a)

Methods

otraverse :: Applicative f => (Element (NonEmpty a) -> f (Element (NonEmpty a))) -> NonEmpty a -> f (NonEmpty a)

omapM :: Applicative m => (Element (NonEmpty a) -> m (Element (NonEmpty a))) -> NonEmpty a -> m (NonEmpty a)

MonoPointed (NonEmpty a)

Methods

opoint :: Element (NonEmpty a) -> NonEmpty a

GrowingAppend (NonEmpty a)

Generic1 * NonEmpty

Associated Types

type Rep1 NonEmpty (f :: NonEmpty -> *) :: k -> *

Methods

from1 :: f a -> Rep1 NonEmpty f a

to1 :: Rep1 NonEmpty f a -> f a

MonadReader (NonEmpty a) (Mealy a)

Methods

ask :: Mealy a (NonEmpty a)

local :: (NonEmpty a -> NonEmpty a) -> Mealy a a -> Mealy a a

reader :: (NonEmpty a -> a) -> Mealy a a

type Rep (NonEmpty a)

type Rep (NonEmpty a) = D1 * (MetaData "NonEmpty" "Data.List.NonEmpty" "base" False) (C1 * (MetaCons ":|" (InfixI RightAssociative 5) False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [a]))))

type Item (NonEmpty a)

type Item (NonEmpty a) = a

type Index (NonEmpty a)

type Index (NonEmpty a) = Int

type Element (NonEmpty a)

type Element (NonEmpty a) = a

type Rep1 * NonEmpty

type Rep1 * NonEmpty = D1 * (MetaData "NonEmpty" "Data.List.NonEmpty" "base" False) (C1 * (MetaCons ":|" (InfixI RightAssociative 5) False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) Par1) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec1 * []))))

nonEmpty :: [a] -> Maybe (NonEmpty a)

nonEmpty efficiently turns a normal list into a NonEmpty stream, producing Nothing if the input is empty.

data TLSSettings :: *

TLS Settings that can be either expressed as simple settings, or as full blown TLS.Params settings.

Unless you need access to parameters that are not accessible through the simple settings, you should use TLSSettingsSimple.

Instances

Show TLSSettings

Methods

showsPrec :: Int -> TLSSettings -> ShowS

show :: TLSSettings -> String

showList :: [TLSSettings] -> ShowS

Default TLSSettings

Methods

def :: TLSSettings

data NominalDiffTime :: *

This is a length of time, as measured by UTC. Conversion functions will treat it as seconds. It has a precision of 10^-12 s. It ignores leap-seconds, so it's not necessarily a fixed amount of clock time. For instance, 23:00 UTC + 2 hours of NominalDiffTime = 01:00 UTC (+ 1 day), regardless of whether a leap-second intervened.

Instances

Enum NominalDiffTime

Methods

succ :: NominalDiffTime -> NominalDiffTime

pred :: NominalDiffTime -> NominalDiffTime

toEnum :: Int -> NominalDiffTime

fromEnum :: NominalDiffTime -> Int

enumFrom :: NominalDiffTime -> [NominalDiffTime]

enumFromThen :: NominalDiffTime -> NominalDiffTime -> [NominalDiffTime]

enumFromTo :: NominalDiffTime -> NominalDiffTime -> [NominalDiffTime]

enumFromThenTo :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime -> [NominalDiffTime]

Eq NominalDiffTime

Methods

(==) :: NominalDiffTime -> NominalDiffTime -> Bool

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

Fractional NominalDiffTime

Methods

(/) :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

recip :: NominalDiffTime -> NominalDiffTime

fromRational :: Rational -> NominalDiffTime

Data NominalDiffTime

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NominalDiffTime -> c NominalDiffTime

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NominalDiffTime

toConstr :: NominalDiffTime -> Constr

dataTypeOf :: NominalDiffTime -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c NominalDiffTime)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NominalDiffTime)

gmapT :: (forall b. Data b => b -> b) -> NominalDiffTime -> NominalDiffTime

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NominalDiffTime -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NominalDiffTime -> r

gmapQ :: (forall d. Data d => d -> u) -> NominalDiffTime -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> NominalDiffTime -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NominalDiffTime -> m NominalDiffTime

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NominalDiffTime -> m NominalDiffTime

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NominalDiffTime -> m NominalDiffTime

Num NominalDiffTime

Methods

(+) :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

(-) :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

(*) :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

negate :: NominalDiffTime -> NominalDiffTime

abs :: NominalDiffTime -> NominalDiffTime

signum :: NominalDiffTime -> NominalDiffTime

fromInteger :: Integer -> NominalDiffTime

Ord NominalDiffTime

Methods

compare :: NominalDiffTime -> NominalDiffTime -> Ordering

(<) :: NominalDiffTime -> NominalDiffTime -> Bool

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

(>) :: NominalDiffTime -> NominalDiffTime -> Bool

(>=) :: NominalDiffTime -> NominalDiffTime -> Bool

max :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

min :: NominalDiffTime -> NominalDiffTime -> NominalDiffTime

Real NominalDiffTime

Methods

toRational :: NominalDiffTime -> Rational

RealFrac NominalDiffTime

Methods

properFraction :: Integral b => NominalDiffTime -> (b, NominalDiffTime)

truncate :: Integral b => NominalDiffTime -> b

round :: Integral b => NominalDiffTime -> b

ceiling :: Integral b => NominalDiffTime -> b

floor :: Integral b => NominalDiffTime -> b

Show NominalDiffTime

Methods

showsPrec :: Int -> NominalDiffTime -> ShowS

show :: NominalDiffTime -> String

showList :: [NominalDiffTime] -> ShowS

ToJSON NominalDiffTime

Methods

toJSON :: NominalDiffTime -> Value

toEncoding :: NominalDiffTime -> Encoding

toJSONList :: [NominalDiffTime] -> Value

toEncodingList :: [NominalDiffTime] -> Encoding

FromJSON NominalDiffTime

WARNING: Only parse lengths of time from trusted input since an attacker could easily fill up the memory of the target system by specifying a scientific number with a big exponent like 1e1000000000.

Methods

parseJSON :: Value -> Parser NominalDiffTime

parseJSONList :: Value -> Parser [NominalDiffTime]

NFData NominalDiffTime

Methods

rnf :: NominalDiffTime -> ()