echo-core/io.github.alexandrepiveteau.echo.core.causality/SequenceNumber

SequenceNumber

value class SequenceNumber : Comparable<SequenceNumber>

A sequence number is a monotonically increasing value defined for a site. It can be seen as a logical timestamp.

Parameters

index

the sequence number for this SequenceNumber.

Types

object Companion

Functions

open operator override fun compareTo(other: SequenceNumber): Int

Compares this SequenceNumber with another SequenceNumber.

operator fun inc(): SequenceNumber

Increments this value.

operator fun plus(count: UInt): SequenceNumber

Adds a certain count to this value.

open override fun toString(): String

Extensions

val SequenceNumber.isSpecified: Boolean

false when this is SequenceNumber.Unspecified.

val SequenceNumber.isUnspecified: Boolean

true when this is SequenceNumber.Unspecified.

inline fun SequenceNumber.takeOrElse(block: () -> SequenceNumber): SequenceNumber

If this SequenceNumber then this is returned, otherwise block is executed and its result is returned.

fun SequenceNumber.toUInt(): UInt

Creates a UInt from a SequenceNumber.