sec-fs2/sec.api.streams/Reads

Reads

trait Reads[F[_]]

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

Type Params
F

the effect type in which Reads operates.

Companion
object
class Object
trait Matchable
class Any

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 Params
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.

Returns

a Stream that emits AllMessage values.

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 Params
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.

Returns

a Stream that emits StreamMessage values.