Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package scalatest

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    Definition Classes
    org
  • package time
    Definition Classes
    scalatest
  • trait SpanSugar extends AnyRef

    Trait providing four implicit conversions that allow you to specify spans of time by invoking "units" methods such as millis, seconds, and minutes on Int, Long, Float, and Double.

    Trait providing four implicit conversions that allow you to specify spans of time by invoking "units" methods such as millis, seconds, and minutes on Int, Long, Float, and Double.

    This trait enables you to specify a span of time in a clear, boilerplate-free way when you need to provide an instance of Span. This can be used, for example, with the failAfter method of trait Timeouts or the timeLimit field of trait TimeLimitedTests. It can also be used to specify timeouts when using traits Eventually, Futures, Waiter. Here are examples of each unit enabled by this trait:

    Int Long Float Double
    1 nanosecond 1L nanosecond 1.0F nanosecond 1.0 nanosecond
    100 nanoseconds 100L nanoseconds 99.8F nanoseconds 99.8 nanoseconds
    1 microsecond 1L microsecond 1.0F microsecond 1.0 microsecond
    100 microseconds 100L microseconds 99.8F microseconds 99.8 microseconds
    1 millisecond 1L millisecond 1.0F millisecond 1.0 millisecond
    100 milliseconds 100L milliseconds 99.8F milliseconds 99.8 milliseconds
    100 millis 100L millis 99.8F millis 99.8 millis
    1 second 1L second 1.0F second 1.0 second
    100 seconds 100L seconds 99.8F seconds 99.8 seconds
    1 minute 1L minute 1.0F minute 1.0 minute
    100 minutes 100L minutes 99.8F minutes 99.8 minutes
    1 hour 1L hour 1.0F hour 1.0 hour
    100 hours 100L hours 99.8F hours 99.8 hours
    1 day 1L day 1.0F day 1.0 day
    100 days 100L days 99.8F days 99.8 days

    This trait is not the default way to specify Spans for two reasons. First, it adds four implicits, which would give the compiler more work to do and may conflict with other implicits the user has in scope. Instead, Span provides a clear, concise default way to specify time spans that requires no implicits. Here's an example:

    Span(1, Second)

    If you already have implicit conversions in scope that provide a similar syntax sugar for expression time spans, you can use that by providing an implicit conversion from the result of those expressions to Span. Note that because of implicit conversions in the Span companion object, you can use a scala.concurrent.duration.Duration (including in its "sugary" form) where a Span is needed, and vice versa.

    Definition Classes
    time
  • FloatingGrainOfTime
  • GrainOfTime
c

org.scalatest.time.SpanSugar

FloatingGrainOfTime

class FloatingGrainOfTime extends AnyRef

Class containing methods that return a Span time value calculated from the Double value passed to the FloatingGrainOfTime constructor.

Source
SpanSugar.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FloatingGrainOfTime
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FloatingGrainOfTime(value: Double)

    value

    the value to be converted

Value Members

  1. def day: Span

    A units method for one day.

    A units method for one day.

    returns

    A Span representing the value passed to the constructor in days

  2. def days: Span

    A units method for days.

    A units method for days.

    returns

    A Span representing the value passed to the constructor multiplied in days

  3. def hour: Span

    A units method for one hour.

    A units method for one hour.

    returns

    A Span representing the value passed to the constructor in hours

  4. def hours: Span

    A units method for hours.

    A units method for hours.

    returns

    A Span representing the value passed to the constructor in hours

  5. def microsecond: Span

    A units method for one microsecond.

    A units method for one microsecond.

    returns

    A Span representing the value passed to the constructor in microseconds

  6. def microseconds: Span

    A units method for microseconds.

    A units method for microseconds.

    returns

    A Span representing the value passed to the constructor in microseconds

  7. def millis: Span

    A shorter units method for milliseconds.

    A shorter units method for milliseconds.

    returns

    A Span representing the value passed to the constructor in milliseconds

  8. def millisecond: Span

    A units method for one millisecond.

    A units method for one millisecond.

    returns

    A Span representing the value passed to the constructor in milliseconds

  9. def milliseconds: Span

    A units method for milliseconds.

    A units method for milliseconds.

    returns

    A Span representing the value passed to the constructor in milliseconds

  10. def minute: Span

    A units method for one minute.

    A units method for one minute.

    returns

    A Span representing the value passed to the constructor in minutes

  11. def minutes: Span

    A units method for minutes.

    A units method for minutes.

    returns

    A Span representing the value passed to the constructor in minutes

  12. def nanosecond: Span

    A units method for one nanosecond.

    A units method for one nanosecond.

    returns

    A Span representing the value passed to the constructor in nanoseconds

  13. def nanoseconds: Span

    A units method for nanoseconds.

    A units method for nanoseconds.

    returns

    A Span representing the value passed to the constructor in nanoseconds

  14. def second: Span

    A units method for one second.

    A units method for one second.

    returns

    A Span representing the value passed to the constructor in seconds

  15. def seconds: Span

    A units method for seconds.

    A units method for seconds.

    returns

    A Span representing the value passed to the constructor in seconds