StreamsSyntax

sec.syntax.StreamsSyntax

Attributes

Source
streams.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ApiSyntax
trait AllSyntax
object all.type
object api.type

Members list

Extensions

Extensions

extension [F[_]](s: Streams[F])
def readAllBackwards(from: LogPosition, maxCount: Long, resolveLinkTos: Boolean): Stream[F, Event]

Read events backwards from the global stream, sec.StreamId.All.

Read events backwards from the global stream, sec.StreamId.All.

Value parameters

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 Event values.

Source
streams.scala
def readAllForwards(from: LogPosition, maxCount: Long, resolveLinkTos: Boolean): Stream[F, Event]

Read events forwards from the global stream, sec.StreamId.All.

Read events forwards from the global stream, sec.StreamId.All.

Value parameters

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 Event values.

Source
streams.scala
def readStreamBackwards(streamId: StreamId, from: StreamPosition, maxCount: Long, resolveLinkTos: Boolean): Stream[F, Event]

Read events backwards from an individual stream. A sec.api.exceptions.StreamNotFound is raised when the stream does not exist.

Read events backwards from an individual stream. A sec.api.exceptions.StreamNotFound is raised when the stream does not exist.

Value parameters

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 read from.

Attributes

Returns

a fs2.Stream that emits Event values.

Source
streams.scala
def readStreamForwards(streamId: StreamId, from: StreamPosition, maxCount: Long, resolveLinkTos: Boolean): Stream[F, Event]

Read events forwards from an individual stream. A sec.api.exceptions.StreamNotFound is raised when the stream does not exist.

Read events forwards from an individual stream. A sec.api.exceptions.StreamNotFound is raised when the stream does not exist.

Value parameters

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 read from.

Attributes

Returns

a fs2.Stream that emits Event values.

Source
streams.scala
def subscribeToAll(exclusiveFrom: Option[LogPosition]): Stream[F, Event]

Subscribes to the global stream, StreamId.All without resolving EventType.LinkTo events.

Subscribes to the global stream, StreamId.All without resolving EventType.LinkTo events.

Value parameters

exclusiveFrom

position to start from. Use scala.None to subscribe from the beginning.

Attributes

Returns

a fs2.Stream that emits Event values.

Source
streams.scala

Subscribes to the global stream, StreamId.All using a subscription filter without resolving EventType.LinkTo events.

Subscribes to the global stream, StreamId.All using a subscription filter without resolving EventType.LinkTo events.

Value parameters

exclusiveFrom

log position to start from. Use scala.None to subscribe from the beginning.

filterOptions

to use when subscribing - See sec.api.SubscriptionFilterOptions.

Attributes

Returns

a fs2.Stream that emits either sec.api.Checkpoint or Event values. How frequent sec.api.Checkpoint is emitted depends on @filterOptions.

Source
streams.scala
def subscribeToStream(streamId: StreamId, exclusiveFrom: Option[StreamPosition]): Stream[F, Event]

Subscribes to an individual stream without resolving EventType.LinkTo events.

Subscribes to an individual stream without resolving EventType.LinkTo events.

Value parameters

exclusiveFrom

stream position to start from. Use scala.None to subscribe from the beginning.

streamId

the id of the stream to subscribe to.

Attributes

Returns

a fs2.Stream that emits Event values.

Source
streams.scala