Reads

sec.api.streams.Reads
See theReads companion object
trait Reads[F[_]]

Low-level API for reading streams that exposes more detailed messages than the Streams API.

Type parameters

F

the effect type in which Reads operates.

Attributes

Companion
object
Source
reads.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def readAllMessages(from: LogPosition, direction: Direction, maxCount: Long, resolveLinkTos: Boolean): Stream[F, AllMessage]

Read AllMessage messages from the global stream, sec.StreamId.All.

Read AllMessage messages from the global stream, sec.StreamId.All.

Value parameters

direction

whether to read forwards or backwards.

from

log position to read from.

maxCount

limits maximum events returned.

resolveLinkTos

whether to resolve EventType.LinkTo events automatically.

Attributes

Returns

a fs2.Stream that emits sec.api.AllMessage values.

Source
reads.scala
def readStreamMessages(streamId: StreamId, from: StreamPosition, direction: Direction, maxCount: Long, resolveLinkTos: Boolean): Stream[F, StreamMessage]

Read StreamMessage messages from an individual stream.

Read StreamMessage messages from an individual stream.

Value parameters

direction

whether to read forwards or backwards.

from

stream position to read from.

maxCount

limits maximum events returned.

resolveLinkTos

whether to resolve EventType.LinkTo events automatically.

streamId

the id of the stream to subscribe to.

Attributes

Returns

a fs2.Stream that emits sec.api.StreamMessage values.

Source
reads.scala