util

Type Members

trait Awaitable[+T] extends AnyRef

Wait for the result of some action.
trait Bijection[A, B] extends (A) ⇒ B

A bijection is a function for which every value in its codomain (set of all possible results) is equivalent to application of the function on a unique value in its domain (all possible inputs).
class BoundedStack[A] extends Seq[A]

A "stack" with a bounded size.
trait Cancellable extends AnyRef

Defines a trait that makes the underlying object *cancellable*.
class CancellableSink extends Cancellable
trait Closable extends AnyRef

Closable is a mixin trait to describe a closable resource.
trait CloseAwaitably extends Awaitable[Unit]

A mixin to make an com.twitter.util.Awaitable out of a com.twitter.util.Closable.
trait Codec[T, S] extends Bijection[T, S] with Encoder[T, S] with Decoder[T, S]

A base trait for all Codecs that translate a type T into a serialized form S
abstract class Command[-T1] extends (T1) ⇒ Unit
class ConstFuture[A] extends Future[A]

A Future that is already completed.
class CountDownLatch extends AnyRef
class Credentials extends AnyRef

Java interface to Credentials.
trait Decoder[T, S] extends AnyRef

A base trait for decoders for type T from a serialized form S
trait DecoderCompanion extends AnyRef
trait Disposable[+T] extends AnyRef

com.twitter.util.Disposable represents a live resource that must be disposed after use.
class DoubleTrouble extends Exception
sealed class Duration extends TimeLike[Duration] with Serializable

A Duration represents the span between two points in time.
trait Encoder[T, S] extends (T) ⇒ S

A base trait for encoders of type T into a serialized form S
trait EncoderCompanion extends AnyRef
trait Event[+T] extends AnyRef

Events are instantaneous values, defined only at particular instants in time (cf.
abstract class ExceptionalFunction[-T1, R] extends Function[T1, R]
abstract class ExceptionalFunction0[R] extends Function0[R]
class ExecutorServiceFuturePool extends FuturePool

A FuturePool implementation backed by an ExecutorService.
trait Extractable[T] extends AnyRef
abstract class FactoryPool[A] extends Pool[A]
abstract class Function[-T1, +R] extends PartialFunction[T1, R]

This class is for Java friendliness.
abstract class Function0[R] extends () ⇒ R
abstract class Function2[-T1, -T2, R] extends (T1, T2) ⇒ R
abstract class Future[+A] extends Awaitable[A]

A computation evaluated asynchronously.
class FutureCancelledException extends Exception
trait FutureEventListener[T] extends AnyRef

An alternative interface for handling Future Events.
trait FuturePool extends AnyRef

A FuturePool executes tasks asynchronously, typically using a pool of worker threads.
class FutureTask[A] extends Promise[A] with Runnable
abstract class FutureTransformer[-A, +B] extends AnyRef

An alternative interface for performing Future transformations; that is, converting a Future[A] to a Future[B].
class InterruptibleExecutorServiceFuturePool extends ExecutorServiceFuturePool
trait JavaSingleton extends AnyRef

A mixin to allow scala objects to be used from java.
class JavaTimer extends Timer
class LastWriteWinsQueue[A] extends Queue[A]

An implementation of java.
final class Local[T] extends AnyRef
class LongOverflowException extends Exception
trait Managed[+T] extends AnyRef

Managed[T] is a resource of type T which lifetime is explicitly managed.
class MockTimer extends Timer
trait Monitor extends AnyRef

A Monitor is a composable exception handler.
case class MonitorException(handlingExc: Throwable, monitorExc: Throwable) extends Exception with Product with Serializable

Wraps an exception that happens when handling another exception in a monitor.
class NoFuture extends Future[Nothing]

A future with no future (never completes).
class NullTimer extends Timer

A NullTimer is not a timer at all: it invokes all tasks immediately and inline.
trait Pool[A] extends AnyRef
class Promise[A] extends Future[A] with Responder[A]

A writeable com.twitter.util.Future that supports merging.
trait ReferenceCountedTimer extends Timer
class ReferenceCountingTimer extends ReferenceCountedTimer
final case class Return[+R](r: R) extends Try[R] with Product with Serializable
class RichU64ByteArray extends AnyRef
class RichU64Long extends AnyRef
class RichU64String extends AnyRef
class RingBuffer[A] extends Seq[A]
class ScheduledThreadPoolTimer extends Timer
trait SignalHandler extends AnyRef
class SimplePool[A] extends Pool[A]
trait StateMachine extends AnyRef
trait Stopwatch extends AnyRef

A stopwatch may be used to measure elapsed time.
class StorageUnit extends Ordered[StorageUnit]

Representation of storage units.
class SunSignalHandler extends SignalHandler
trait TempFolder extends AnyRef

Test mixin that creates a new folder for a block of code to execute in.
class ThreadStoppingTimer extends Timer
final case class Throw[+R](e: Throwable) extends Try[R] with Product with Serializable
sealed class Time extends TimeLike[Time] with Serializable

An absolute point in time, represented as the number of nanoseconds since the Unix epoch.
trait TimeControl extends AnyRef
class TimeFormat extends AnyRef

A thread-safe wrapper around a SimpleDateFormat object.
trait TimeLike[This <: TimeLike[This]] extends Ordered[This]

A common trait for time-like values.
trait TimeLikeOps[This <: TimeLike[This]] extends AnyRef
class TimeoutException extends java.util.concurrent.TimeoutException
trait Timer extends AnyRef
trait TimerTask extends Closable
sealed abstract class Try[+R] extends AnyRef

This class represents a computation that can succeed or fail.
trait Updatable[T] extends AnyRef

Denotes an updatable container.
trait Var[+T] extends AnyRef

Trait Var represents a variable.
trait Witness[-N] extends AnyRef

A witness is the recipient of Event.
trait Config[T] extends () ⇒ T

A config object contains vars for configuring an object of type T, and an apply() method which turns this config into an object of type T.

Value Members

object Await

Await the result of some action.
object Awaitable
object Base64Long

Efficient conversion of Longs to base 64 encoded strings.
object Bijection
object BinaryCodec
object Cancellable
object Closable
object Codec extends EncoderCompanion with DecoderCompanion
object Credentials

Simple helper to read authentication credentials from a text file.
object Decoder extends DecoderCompanion
object Disposable
object Duration extends TimeLikeOps[Duration] with Serializable
object Encoder extends EncoderCompanion
object Event
object Function
object Future
object FuturePool
object FutureTask
object HandleSignal
object Local
object LongOverflowArith
object Managed
object Memoize
object Monitor extends Monitor

Defines the (Future)-{{Local}} monitor as well as some monitor utilities.
object NetUtil
object NonFatal

A classifier of fatal exceptions
object NullMonitor extends Monitor

A monitor that always fails to handle an exception.
object NullTimerTask extends TimerTask
object Promise
object RandomSocket

A generator of random local java.net.InetSocketAddress objects with ephemeral ports.
object Return extends Serializable
object RootMonitor extends Monitor
object SignalHandlerFactory
object StateMachine
object Stopwatch extends Stopwatch

The system com.twitter.util.Stopwatch measures elapsed time using System.nanoTime.
object StorageUnit
val StorageUnitConversions: storage.type
object SunSignalHandler
object Time extends TimeLikeOps[Time] with Serializable

Use Time.now in your program instead of System.currentTimeMillis, and unit tests will be able to adjust the current time to verify timeouts and other time-dependent behavior, without calling sleep.
val TimeConversions: time.type
object Timer
object Try

The Try type represents a computation that may either result in an exception or return a success value.
object U64
object Unsafe
object Var
object Witness
package repository

package util

Type Members

trait Awaitable[+T] extends AnyRef

trait Bijection[A, B] extends (A) ⇒ B

class BoundedStack[A] extends Seq[A]

trait Cancellable extends AnyRef

class CancellableSink extends Cancellable

trait Closable extends AnyRef

trait CloseAwaitably extends Awaitable[Unit]

trait Codec[T, S] extends Bijection[T, S] with Encoder[T, S] with Decoder[T, S]

abstract class Command[-T1] extends (T1) ⇒ Unit

class ConstFuture[A] extends Future[A]

class CountDownLatch extends AnyRef

class Credentials extends AnyRef

trait Decoder[T, S] extends AnyRef

trait DecoderCompanion extends AnyRef

trait Disposable[+T] extends AnyRef

class DoubleTrouble extends Exception

sealed class Duration extends TimeLike[Duration] with Serializable

trait Encoder[T, S] extends (T) ⇒ S

trait EncoderCompanion extends AnyRef

trait Event[+T] extends AnyRef

abstract class ExceptionalFunction[-T1, R] extends Function[T1, R]

abstract class ExceptionalFunction0[R] extends Function0[R]

class ExecutorServiceFuturePool extends FuturePool

trait Extractable[T] extends AnyRef

abstract class FactoryPool[A] extends Pool[A]

abstract class Function[-T1, +R] extends PartialFunction[T1, R]

abstract class Function0[R] extends () ⇒ R

abstract class Function2[-T1, -T2, R] extends (T1, T2) ⇒ R

abstract class Future[+A] extends Awaitable[A]

class FutureCancelledException extends Exception

trait FutureEventListener[T] extends AnyRef

trait FuturePool extends AnyRef

class FutureTask[A] extends Promise[A] with Runnable

abstract class FutureTransformer[-A, +B] extends AnyRef

class InterruptibleExecutorServiceFuturePool extends ExecutorServiceFuturePool

trait JavaSingleton extends AnyRef

class JavaTimer extends Timer

class LastWriteWinsQueue[A] extends Queue[A]

final class Local[T] extends AnyRef

class LongOverflowException extends Exception

trait Managed[+T] extends AnyRef

class MockTimer extends Timer

trait Monitor extends AnyRef

case class MonitorException(handlingExc: Throwable, monitorExc: Throwable) extends Exception with Product with Serializable

class NoFuture extends Future[Nothing]

class NullTimer extends Timer

trait Pool[A] extends AnyRef

class Promise[A] extends Future[A] with Responder[A]

trait ReferenceCountedTimer extends Timer

class ReferenceCountingTimer extends ReferenceCountedTimer

final case class Return[+R](r: R) extends Try[R] with Product with Serializable

class RichU64ByteArray extends AnyRef

class RichU64Long extends AnyRef

class RichU64String extends AnyRef

class RingBuffer[A] extends Seq[A]

class ScheduledThreadPoolTimer extends Timer

trait SignalHandler extends AnyRef

class SimplePool[A] extends Pool[A]

trait StateMachine extends AnyRef

trait Stopwatch extends AnyRef

class StorageUnit extends Ordered[StorageUnit]

class SunSignalHandler extends SignalHandler

trait TempFolder extends AnyRef

class ThreadStoppingTimer extends Timer

final case class Throw[+R](e: Throwable) extends Try[R] with Product with Serializable

sealed class Time extends TimeLike[Time] with Serializable

trait TimeControl extends AnyRef

class TimeFormat extends AnyRef

trait TimeLike[This <: TimeLike[This]] extends Ordered[This]

trait TimeLikeOps[This <: TimeLike[This]] extends AnyRef

class TimeoutException extends java.util.concurrent.TimeoutException

trait Timer extends AnyRef

trait TimerTask extends Closable

sealed abstract class Try[+R] extends AnyRef

trait Updatable[T] extends AnyRef

trait Var[+T] extends AnyRef

trait Witness[-N] extends AnyRef