Packages

c

sec.syntax

StreamsOps

final class StreamsOps[F[_]] extends AnyVal

Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamsOps
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StreamsOps(s: Streams[F])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  6. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  7. def readAllBackwards(from: LogPosition = LogPosition.End, maxCount: Long = Long.MaxValue, resolveLinkTos: Boolean = false): Stream[F, AllEvent]

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

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

    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.

  8. def readAllForwards(from: LogPosition = LogPosition.Start, maxCount: Long = Long.MaxValue, resolveLinkTos: Boolean = false): Stream[F, AllEvent]

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

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

    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.

  9. def readStreamBackwards(streamId: StreamId, from: StreamPosition = StreamPosition.End, maxCount: Long = Long.MaxValue, resolveLinkTos: Boolean = false): Stream[F, StreamEvent]

    Read events backwards from an individual stream.

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

    streamId

    the id of the stream to read from.

    from

    stream position to read from.

    maxCount

    limits maximum events returned.

    resolveLinkTos

    whether to resolve EventType.LinkTo events automatically.

    returns

    a Stream that emits StreamEvent values.

  10. def readStreamForwards(streamId: StreamId, from: StreamPosition = StreamPosition.Start, maxCount: Long = Long.MaxValue, resolveLinkTos: Boolean = false): Stream[F, StreamEvent]

    Read events forwards from an individual stream.

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

    streamId

    the id of the stream to read from.

    from

    stream position to read from.

    maxCount

    limits maximum events returned.

    resolveLinkTos

    whether to resolve EventType.LinkTo events automatically.

    returns

    a Stream that emits StreamEvent values.

  11. val s: Streams[F]
  12. def subscribeToAll(exclusiveFrom: Option[LogPosition], filterOptions: SubscriptionFilterOptions): Stream[F, Either[Checkpoint, AllEvent]]

    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.

    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.

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

    exclusiveFrom

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

    returns

    a Stream that emits AllEvent values.

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

    streamId

    the id of the stream to subscribe to.

    exclusiveFrom

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

    returns

    a Stream that emits StreamEvent values.

  15. def toString(): String
    Definition Classes
    Any

Inherited from AnyVal

Inherited from Any

Ungrouped