AllSyntax

trait AllSyntax extends StringSyntax with ApiSyntax
Source:
all.scala
trait ApiSyntax
class Object
trait Matchable
class Any
object all.type

Extensions

Inherited extensions

extension [F[_]](ms: MetaStreams[F])
def setCacheControl(id: Id, expectedState: StreamState, cacheControl: FiniteDuration)(implicit evidence$3: MonadThrow[F]): F[WriteResult]

Sets cache control in FiniteDuration for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

Sets cache control in FiniteDuration for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

Value parameters:
cacheControl

the cache control FiniteDuration value for data in the stream. Valid values are FiniteDuration greater or equal to 1 second. An InvalidInput exception is raised for invalid input value.

expectedState

the state that the stream is expected to in. See StreamState for details.

id

the id of the stream.

Inherited from:
MetaStreamsSyntax
Source:
metastreams.scala
def setMaxAge(id: Id, expectedState: StreamState, age: FiniteDuration)(implicit evidence$1: MonadThrow[F]): F[WriteResult]

Sets max age in FiniteDuration for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

Sets max age in FiniteDuration for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

Value parameters:
age

the max age FiniteDuration value for data in the stream. Valid values are FiniteDuration greater or equal to 1 second. An InvalidInput exception is raised for invalid input value.

expectedState

the state that the stream is expected to in. See StreamState for details.

id

the id of the stream.

Inherited from:
MetaStreamsSyntax
Source:
metastreams.scala
def setMaxCount(id: Id, expectedState: StreamState, count: Int)(implicit evidence$2: MonadThrow[F]): F[WriteResult]

Sets max count in Int for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

Sets max count in Int for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

Value parameters:
count

the max count Int value for data in the stream. Valid values are greater or equal to 1. An InvalidInput exception is raised for invalid input value.

expectedState

the state that the stream is expected to in. See StreamState for details.

id

the id of the stream.

Inherited from:
MetaStreamsSyntax
Source:
metastreams.scala
def setTruncateBefore(id: Id, expectedState: StreamState, truncateBefore: Long)(implicit evidence$4: MonadThrow[F]): F[WriteResult]

Sets truncated before in Long for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

Sets truncated before in Long for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

Value parameters:
expectedState

the state that the stream is expected to in. See StreamState for details.

id

the id of the stream.

truncatedBefore

the truncated before Long value for data in the stream. Valid values are Long greater or equal to 0L. An InvalidInput exception is raised for invalid input value.

Inherited from:
MetaStreamsSyntax
Source:
metastreams.scala
extension [F[_]](r: Reads[F])
def readAllMessagesBackwards(from: LogPosition, maxCount: Long, resolveLinkTos: Boolean): Stream[F, AllMessage]

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

Read AllMessage messages 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.

Returns:

a Stream that emits AllMessage values.

Inherited from:
ReadsSyntax
Source:
reads.scala
def readAllMessagesForwards(from: LogPosition, maxCount: Long, resolveLinkTos: Boolean): Stream[F, AllMessage]

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

Read AllMessage messages 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.

Returns:

a Stream that emits AllMessage values.

Inherited from:
ReadsSyntax
Source:
reads.scala
def readStreamMessagesBackwards(streamId: StreamId, from: StreamPosition, maxCount: Long, resolveLinkTos: Boolean): Stream[F, StreamMessage]

Read StreamMessage messages backwards from an individual stream.

Read StreamMessage messages backwards from an individual stream.

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.

Returns:

a Stream that emits StreamMessage values.

Inherited from:
ReadsSyntax
Source:
reads.scala
def readStreamMessagesForwards(streamId: StreamId, from: StreamPosition, maxCount: Long, resolveLinkTos: Boolean): Stream[F, StreamMessage]

Read StreamMessage messages forwards from an individual stream.

Read StreamMessage messages forwards from an individual stream.

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.

Returns:

a Stream that emits StreamMessage values.

Inherited from:
ReadsSyntax
Source:
reads.scala
extension [F[_]](s: String)
def utf8Bytes(implicit evidence$1: ApplicativeThrow[F]): F[ByteVector]
Inherited from:
StringSyntax
Source:
std.scala
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.

Value parameters:
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.

Inherited from:
StreamsSyntax
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.

Value parameters:
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.

Inherited from:
StreamsSyntax
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.

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.

Returns:

a Stream that emits StreamEvent values.

Inherited from:
StreamsSyntax
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.

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.

Returns:

a Stream that emits StreamEvent values.

Inherited from:
StreamsSyntax
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 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.

Inherited from:
StreamsSyntax
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.

Value parameters:
exclusiveFrom

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

Returns:

a Stream that emits AllEvent values.

Inherited from:
StreamsSyntax
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.

Value parameters:
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.

Inherited from:
StreamsSyntax
Source:
streams.scala