A bunch of idiomatic, small General Purpose tools.
See the Scaladoc here
Pre-compiled jars for each set of tools (util-core, util-collection etc) are available in the Twitter Maven repository, here: http://maven.twttr.com/
We use Semantic Versioning for published artifacts.
An example SBT dependency string for the util-collection tools would look like this:
val collUtils = "com.twitter" %% "util-collection" % "6.12.1"import com.twitter.conversions.time._
val duration1 = 1.second
val duration2 = 2.minutes
duration1.inMillis // => 1000Limport com.twitter.conversions.storage._
val amount = 8.megabytes
amount.inBytes // => 8192L
amount.inGigabytes // => 0.0078125A Non-actor re-implementation of Scala Futures.
import com.twitter.util.{Future, Promise}
val f = new Promise[Int]
val g = f map { result => result + 1 }
f.setValue(1)
g.get(1.second) // => This blocks for the futures result (and eventually returns 2)
// Another option:
g respond { result =>
println(result) // => prints "2"
}
// Using for expressions:
val xFuture = Future(1)
val yFuture = Future(2)
for (
x <- xFuture
y <- yFuture
) {
println(x + y) // => prints "3"
}The LruMap is an LRU with a maximum size passed in. If the map is full it expires items in FIFO order. Reading a value will move an item to the top of the stack.
import com.twitter.util.LruMap
val f = new LruMap[Key, Value](15) // this is of type mutable.Map[Key, Value]import com.twitter.util.MapMaker
val map = MapMaker[Key, Value] { config =>
config.weakKeys()
config.weakValues()
} // this is of type mutable.Map[Key, Value]The pool order is FIFO
val queue = new mutable.Queue[Int] ++ List(1, 2, 3)
val pool = new SimplePool(queue)
// Note that the pool returns Futures, it doesn't block on exhaustion.
pool.reserve()() mustEqual 1
pool.reserve { item =>
println(item) // prints "2"
}Here is a pool of even-number generators. It stores 4 numbers at a time:
val pool = new FactoryPool[Int](4) {
var count = 0
def makeItem() = { count += 1; Future(count) }
def isHealthy(i: Int) = i % 2 == 0
}It checks the health when you successfully reserve an object (i.e., when the Future yields).
Dynamically evaluates Scala strings and files.
This is motivated by the desire to have a type-safe alternative to textual configuration formats such as YAML, JSON, or .properties files. Its advantages over these text formats are
- Strong typing and compiler checking. If it doesn't compile and doesn't conform to the type you expect, you get an exception
- The full power of Scala in your config. You don't have to use it. But you can.
import com.xxx.MyConfig
new MyConfig {
val myValue = 1
val myTime = 2.seconds
val myStorage = 14.kilobytes
}import com.xxx.MyConfig
val config = Eval[MyConfig](new File("config/Development.scala"))Major version 6 introduced some breaking changes:
- Futures are no longer
Cancellable; cancellation is replaced with a simpler interrupt mechanism. - Time and duration implement true sentinels (similar to infinities in doubles).
Time.nowuses system time instead of nanotime + offset. - The (dangerous) implicit conversion from a
Durationto aLongwas removed. Trys andFutures no longer handle fatal exceptions: these are propagated to the dispatching thread.
Method raise on Future (def raise(cause: Throwable)) raises the interrupt described by cause to the producer of this Future. Interrupt handlers are installed on a Promise using setInterruptHandler, which takes a partial function:
val p = new Promise[T]
p.setInterruptHandler {
case exc: MyException =>
// deal with interrupt..
}
Interrupts differ in semantics from cancellation in important ways: there can only be one interrupt handler per promise, and interrupts are only delivered if the promise is not yet complete.
Like arithmetic on doubles, Time and Duration arithmetic is now free of overflows. Instead, they overflow to Top and Bottom values, which are analogous to positive and negative infinity.
Since the resolution of Time.now has been reduced (and is also more expensive due to its use of system time), a new Stopwatch API has been introduced in order to calculate durations of time.
It's used simply:
val elapsed: () => Duration = Stopwatch.start()
which is read by applying elapsed:
val duration: Duration = elapsed()