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

Concise view

Extensions

Extensions

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

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

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

Attributes

from

log position to read from.

maxCount

limits maximum events returned.

resolveLinkTos

whether to resolve ")">EventType.LinkTo events automatically.

Returns:

a Stream that emits AllEvent values.

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

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

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

Attributes

from

log position to read from.

maxCount

limits maximum events returned.

resolveLinkTos

whether to resolve ")">EventType.LinkTo events automatically.

Returns:

a Stream that emits AllEvent values.

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

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.

Attributes

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.

Returns:

a Stream that emits StreamEvent values.

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

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.

Attributes

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.

Returns:

a Stream that emits StreamEvent values.

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

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

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

Attributes

exclusiveFrom

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

Returns:

a Stream that emits AllEvent 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.

Attributes

exclusiveFrom

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

filterOptions

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

Returns:

a Stream that emits either Checkpoint or AllEvent values. How frequent Checkpoint is emitted depends on filterOptions.

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

Subscribes to an individual stream without resolving ")">EventType.LinkTo events.

Subscribes to an individual stream without resolving ")">EventType.LinkTo events.

Attributes

exclusiveFrom

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

streamId

the id of the stream to subscribe to.

Returns:

a Stream that emits StreamEvent values.

Source:
streams.scala