sec-fs2/sec.syntax/MetaStreamsSyntax

MetaStreamsSyntax

trait MetaStreamsSyntax
Source:
metastreams.scala
class Object
trait Matchable
class Any
trait ApiSyntax
trait AllSyntax
object all.type
object api.type

Extensions

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.

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.

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.

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.

Source:
metastreams.scala