Scala 3/API/scala.concurrent.duration/Duration

Duration

sealed abstract class Duration extends Serializable with Ordered[Duration]

This class is not meant as a general purpose representation of time, it is optimized for the needs of scala.concurrent.

Utility for working with java.util.concurrent.TimeUnit durations.

This class is not meant as a general purpose representation of time, it is optimized for the needs of scala.concurrent.

Basic Usage

Examples:

import scala.concurrent.duration._

val duration = Duration(100, MILLISECONDS)
val duration = Duration(100, "millis")

duration.toNanos
duration < 1.second
duration <= Duration.Inf

Invoking inexpressible conversions (like calling toSeconds on an infinite duration) will throw an IllegalArgumentException.

Implicits are also provided for Int, Long and Double. Example usage:

import scala.concurrent.duration._

val duration = 100.millis

The DSL provided by the implicit conversions always allows construction of finite durations, even for infinite Double inputs; use Duration.Inf instead.

Extractors, parsing and arithmetic are also included:

val d = Duration("1.2 µs")
val Duration(length, unit) = 5 millis
val d2 = d * 2.5
val d3 = d2 + 1.millisecond

Handling of Time Units

Calculations performed on finite durations always retain the more precise unit of either operand, no matter whether a coarser unit would be able to exactly express the same duration. This means that Duration can be used as a lossless container for a (length, unit) pair if it is constructed using the corresponding methods and no arithmetic is performed on it; adding/subtracting durations should in that case be done with care.

Correspondence to Double Semantics

The semantics of arithmetic operations on Duration are two-fold:

- exact addition/subtraction with nanosecond resolution for finite durations, independent of the summands' magnitude - isomorphic to java.lang.Double when it comes to infinite or undefined values

The conversion between Duration and Double is done using Duration.toUnit (with unit NANOSECONDS) and Duration.fromNanos(Double)

Ordering

The default ordering is consistent with the ordering of Double numbers, which means that Undefined is considered greater than all other durations, including Duration.Inf.

Companion
object
class Object
trait Matchable
class Any
class Infinite

Value members

Abstract methods

def *(factor: Double): Duration

Return this duration multiplied by the scalar factor.

Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.

Throws
IllegalArgumentException

in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

def +(other: Duration): Duration

Return the sum of that duration and this.

Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.

Throws
IllegalArgumentException

in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

def -(other: Duration): Duration

Return the difference of that duration and this.

Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.

Throws
IllegalArgumentException

in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

def /(divisor: Double): Duration

Return this duration divided by the scalar factor.

Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.

Throws
IllegalArgumentException

in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

def /(divisor: Duration): Double

Return the quotient of this and that duration as floating-point number.

Return the quotient of this and that duration as floating-point number. The semantics are determined by Double as if calculating the quotient of the nanosecond lengths of both factors.

def isFinite: Boolean

This method returns whether this duration is finite, which is not the same as !isInfinite for Double because this method also returns false for Duration.Undefined.

This method returns whether this duration is finite, which is not the same as !isInfinite for Double because this method also returns false for Duration.Undefined.

def length: Long

Obtain the length of this Duration measured in the unit obtained by the unit method.

Obtain the length of this Duration measured in the unit obtained by the unit method.

Throws
IllegalArgumentException

when invoked on a non-finite duration

def toCoarsest: Duration

Return duration which is equal to this duration but with a coarsest Unit, or self in case it is already the coarsest Unit

Return duration which is equal to this duration but with a coarsest Unit, or self in case it is already the coarsest Unit

Examples:

Duration(60, MINUTES).toCoarsest // Duration(1, HOURS)
Duration(1000, MILLISECONDS).toCoarsest // Duration(1, SECONDS)
Duration(48, HOURS).toCoarsest // Duration(2, DAYS)
Duration(5, SECONDS).toCoarsest // Duration(5, SECONDS)
def toDays: Long

Return the length of this duration measured in whole days, rounding towards zero.

Return the length of this duration measured in whole days, rounding towards zero.

Throws
IllegalArgumentException

when invoked on a non-finite duration

def toHours: Long

Return the length of this duration measured in whole hours, rounding towards zero.

Return the length of this duration measured in whole hours, rounding towards zero.

Throws
IllegalArgumentException

when invoked on a non-finite duration

def toMicros: Long

Return the length of this duration measured in whole microseconds, rounding towards zero.

Return the length of this duration measured in whole microseconds, rounding towards zero.

Throws
IllegalArgumentException

when invoked on a non-finite duration

def toMillis: Long

Return the length of this duration measured in whole milliseconds, rounding towards zero.

Return the length of this duration measured in whole milliseconds, rounding towards zero.

Throws
IllegalArgumentException

when invoked on a non-finite duration

def toMinutes: Long

Return the length of this duration measured in whole minutes, rounding towards zero.

Return the length of this duration measured in whole minutes, rounding towards zero.

Throws
IllegalArgumentException

when invoked on a non-finite duration

def toNanos: Long

Return the length of this duration measured in whole nanoseconds, rounding towards zero.

Return the length of this duration measured in whole nanoseconds, rounding towards zero.

Throws
IllegalArgumentException

when invoked on a non-finite duration

def toSeconds: Long

Return the length of this duration measured in whole seconds, rounding towards zero.

Return the length of this duration measured in whole seconds, rounding towards zero.

Throws
IllegalArgumentException

when invoked on a non-finite duration

def toUnit(unit: TimeUnit): Double

Return the number of nanoseconds as floating point number, scaled down to the given unit.

Return the number of nanoseconds as floating point number, scaled down to the given unit. The result may not precisely represent this duration due to the Double datatype's inherent limitations (mantissa size effectively 53 bits). Non-finite durations are represented as - Duration.Undefined is mapped to Double.NaN - Duration.Inf is mapped to Double.PositiveInfinity - Duration.MinusInf is mapped to Double.NegativeInfinity

def unary_-: Duration

Negate this duration.

Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.

def unit: TimeUnit

Obtain the time unit in which the length of this duration is measured.

Obtain the time unit in which the length of this duration is measured.

Throws
IllegalArgumentException

when invoked on a non-finite duration

Concrete methods

def div(divisor: Double): Duration

Return this duration divided by the scalar factor.

Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.

Throws
IllegalArgumentException

in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

def div(other: Duration): Double

Return the quotient of this and that duration as floating-point number.

Return the quotient of this and that duration as floating-point number. The semantics are determined by Double as if calculating the quotient of the nanosecond lengths of both factors.

def gt(other: Duration): Boolean
def gteq(other: Duration): Boolean
def lt(other: Duration): Boolean
def lteq(other: Duration): Boolean
def max(other: Duration): Duration

Return the larger of this and that duration as determined by the natural ordering.

Return the larger of this and that duration as determined by the natural ordering.

def min(other: Duration): Duration

Return the smaller of this and that duration as determined by the natural ordering.

Return the smaller of this and that duration as determined by the natural ordering.

def minus(other: Duration): Duration

Return the difference of that duration and this.

Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.

Throws
IllegalArgumentException

in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

def mul(factor: Double): Duration

Return this duration multiplied by the scalar factor.

Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.

Throws
IllegalArgumentException

in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

def neg(): Duration

Negate this duration.

Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.

def plus(other: Duration): Duration

Return the sum of that duration and this.

Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.

Throws
IllegalArgumentException

in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

def swap: (T2, T1)
Implicitly added by durationToPair

Swaps the elements of this Tuple.

Swaps the elements of this Tuple.

Returns

a new Tuple where the first element is the second element of this Tuple and the second element is the first element of this Tuple.

Inherited methods

inline def *:[H, This >: (T1, T2) <: Tuple](x: H): H *: This
Implicitly added by durationToPair

Return a new tuple by prepending the element to this tuple.

Return a new tuple by prepending the element to this tuple. This operation is O(this.size)

Inherited from
Tuple
inline def ++[This >: (T1, T2) <: Tuple](that: Tuple): Concat[This, that]
Implicitly added by durationToPair

Return a new tuple by concatenating this tuple with that tuple.

Return a new tuple by concatenating this tuple with that tuple. This operation is O(this.size + that.size)

Inherited from
Tuple
def <(that: Duration): Boolean

Returns true if this is less than that

Returns true if this is less than that

Inherited from
Ordered
def <=(that: Duration): Boolean

Returns true if this is less than or equal to that.

Returns true if this is less than or equal to that.

Inherited from
Ordered
def >(that: Duration): Boolean

Returns true if this is greater than that.

Returns true if this is greater than that.

Inherited from
Ordered
def >=(that: Duration): Boolean

Returns true if this is greater than or equal to that.

Returns true if this is greater than or equal to that.

Inherited from
Ordered
inline def apply[This >: (T1, T2) <: NonEmptyTuple](n: Int): Elem[This, n]
Implicitly added by durationToPair

Get the i-th element of this tuple.

Get the i-th element of this tuple. Equivalent to productElement but with a precise return type.

Inherited from
NonEmptyTuple
def compare(that: Duration): Int

Result of comparing this with operand that.

Result of comparing this with operand that.

Implement this method to determine how instances of A will be sorted.

Returns x where:

  • x < 0 when this < that

  • x == 0 when this == that

  • x > 0 when this > that

Inherited from
Ordered
def compareTo(that: Duration): Int

Result of comparing this with operand that.

Result of comparing this with operand that.

Inherited from
Ordered
inline def drop[This >: (T1, T2) <: Tuple](n: Int): Drop[This, n]
Implicitly added by durationToPair

Given a tuple (a1, ..., am), returns the tuple (an+1, ..., am) consisting all its elements except the first n ones.

Given a tuple (a1, ..., am), returns the tuple (an+1, ..., am) consisting all its elements except the first n ones.

Inherited from
Tuple
inline def head[This >: (T1, T2) <: NonEmptyTuple]: Head[This]
Implicitly added by durationToPair

Get the head of this tuple

Get the head of this tuple

Inherited from
NonEmptyTuple
inline def map[F[_]](f: [t] => (x$1: t) => F[t]): Map[(T1, T2), F]
Implicitly added by durationToPair

Called on a tuple (a1, ..., an), returns a new tuple (f(a1), ..., f(an)).

Called on a tuple (a1, ..., an), returns a new tuple (f(a1), ..., f(an)). The result is typed as (F[A1], ..., F[An]) if the tuple type is fully known. If the tuple is of the form a1 *: ... *: Tuple (that is, the tail is not known to be the cons type.

Inherited from
Tuple
def productElementNames: Iterator[String]
Implicitly added by durationToPair

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Inherited from
Product
def productIterator: Iterator[Any]
Implicitly added by durationToPair

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Returns

in the default implementation, an Iterator[Any]

Inherited from
Product
inline def size[This >: (T1, T2) <: Tuple]: Size[This]
Implicitly added by durationToPair

Return the size (or arity) of the tuple

Return the size (or arity) of the tuple

Inherited from
Tuple
inline def splitAt[This >: (T1, T2) <: Tuple](n: Int): (This, n)
Implicitly added by durationToPair

Given a tuple (a1, ..., am), returns a pair of the tuple (a1, ..., an) consisting of the first n elements, and the tuple (an+1, ..., am) consisting of the remaining elements.

Given a tuple (a1, ..., am), returns a pair of the tuple (a1, ..., an) consisting of the first n elements, and the tuple (an+1, ..., am) consisting of the remaining elements.

Inherited from
Tuple
inline def tail[This >: (T1, T2) <: NonEmptyTuple]: Tail[This]
Implicitly added by durationToPair

Get the tail of this tuple.

Get the tail of this tuple. This operation is O(this.size)

Inherited from
NonEmptyTuple
inline def take[This >: (T1, T2) <: Tuple](n: Int): Take[This, n]
Implicitly added by durationToPair

Given a tuple (a1, ..., am), returns the tuple (a1, ..., an) consisting of its first n elements.

Given a tuple (a1, ..., am), returns the tuple (a1, ..., an) consisting of its first n elements.

Inherited from
Tuple
inline def toArray: Array[Object]
Implicitly added by durationToPair

Create a copy this tuple as an Array

Create a copy this tuple as an Array

Inherited from
Tuple
inline def toIArray: IArray[Object]
Implicitly added by durationToPair

Create a copy this tuple as an IArray

Create a copy this tuple as an IArray

Inherited from
Tuple
inline def toList: List[Union[(T1, T2)]]
Implicitly added by durationToPair

Create a copy this tuple as a List

Create a copy this tuple as a List

Inherited from
Tuple
inline def zip[This >: (T1, T2) <: Tuple, T2 <: Tuple](t2: T2): Zip[This, T2]
Implicitly added by durationToPair

Given two tuples, (a1, ..., an) and (a1, ..., an), returns a tuple ((a1, b1), ..., (an, bn)).

Given two tuples, (a1, ..., an) and (a1, ..., an), returns a tuple ((a1, b1), ..., (an, bn)). If the two tuples have different sizes, the extra elements of the larger tuple will be disregarded. The result is typed as ((A1, B1), ..., (An, Bn)) if at least one of the tuple types has a EmptyTuple tail. Otherwise the result type is (A1, B1) *: ... *: (Ai, Bi) *: Tuple

Inherited from
Tuple