scala.util
Members list
Type members
Classlikes
Adds chaining methods tap
and pipe
to every type.
Attributes
- Source
- ChainingOps.scala
- Supertypes
- Known subtypes
-
object chaining
A utility object to support command line parsing for @main methods
A utility object to support command line parsing for @main methods
Attributes
- Source
- CommandLineParser.scala
- Supertypes
- Self type
-
CommandLineParser.type
DynamicVariables
provide a binding mechanism where the current value is found through dynamic scope, but where access to the variable itself is resolved through static scope.
DynamicVariables
provide a binding mechanism where the current value is found through dynamic scope, but where access to the variable itself is resolved through static scope.
The current value can be retrieved with the value method. New values should be pushed using the withValue
method. Values pushed via withValue
only stay valid while the withValue
's second argument, a parameterless closure, executes. When the second argument finishes, the variable reverts to the previous value.
someDynamicVariable.withValue(newValue) {
// ... code called in here that calls value ...
// ... will be given back the newValue ...
}
Each thread gets its own stack of bindings. When a new thread is created, the DynamicVariable
gets a copy of the stack of bindings from the parent thread, and from then on the bindings for the new thread are independent of those for the original thread.
Attributes
- Source
- DynamicVariable.scala
- Supertypes
Represents a value of one of two possible types (a disjoint union).
Represents a value of one of two possible types (a disjoint union). An instance of Either
is an instance of either scala.util.Left or scala.util.Right.
A common use of Either
is as an alternative to scala.Option for dealing with possibly missing values. In this usage, scala.None is replaced with a scala.util.Left which can contain useful information. scala.util.Right takes the place of scala.Some. Convention dictates that Left
is used for failure and Right
is used for success.
For example, you could use Either[String, Int]
to indicate whether a received input is a String
or an Int
.
import scala.io.StdIn._
val in = readLine("Type Either a string or an Int: ")
val result: Either[String,Int] =
try Right(in.toInt)
catch {
case e: NumberFormatException => Left(in)
}
result match {
case Right(x) => s"You passed me the Int: $x, which I will increment. $x + 1 = ${x+1}"
case Left(x) => s"You passed me the String: $x"
}
Either
is right-biased, which means that Right
is assumed to be the default case to operate on. If it is Left
, operations like map
and flatMap
return the Left
value unchanged:
def doubled(i: Int) = i * 2
Right(42).map(doubled) // Right(84)
Left(42).map(doubled) // Left(42)
Since Either
defines the methods map
and flatMap
, it can also be used in for comprehensions:
val right1 = Right(1) : Right[Double, Int]
val right2 = Right(2)
val right3 = Right(3)
val left23 = Left(23.0) : Left[Double, Int]
val left42 = Left(42.0)
for {
x <- right1
y <- right2
z <- right3
} yield x + y + z // Right(6)
for {
x <- right1
y <- right2
z <- left23
} yield x + y + z // Left(23.0)
for {
x <- right1
y <- left23
z <- right2
} yield x + y + z // Left(23.0)
// Guard expressions are not supported:
for {
i <- right1
if i > 0
} yield i
// error: value withFilter is not a member of Right[Double,Int]
// Similarly, refutable patterns are not supported:
for (x: Int <- right1) yield x
// error: value withFilter is not a member of Right[Double,Int]
// To use a filtered value, convert to an Option first,
// which drops the Left case, as None contains no value:
for {
i <- right1.toOption
if i > 0
} yield i
Since for
comprehensions use map
and flatMap
, the types of function parameters used in the expression must be inferred. These types are constrained by the Either
values. In particular, because of right-biasing, Left
values may require an explicit type argument for type parameter B
, the right value. Otherwise, it might be inferred as Nothing
.
for {
x <- left23
y <- right1
z <- left42 // type at this position: Either[Double, Nothing]
} yield x + y + z
// ^
// error: ambiguous reference to overloaded definition,
// both method + in class Int of type (x: Char)Int
// and method + in class Int of type (x: Byte)Int
// match argument types (Nothing)
for (x <- right2 ; y <- left23) yield x + y // Left(23.0)
for (x <- right2 ; y <- left42) yield x + y // error
for {
x <- right1
y <- left42 // type at this position: Either[Double, Nothing]
z <- left23
} yield x + y + z
// Left(42.0), but unexpectedly a `Either[Double,String]`
Attributes
- Companion
- object
- Source
- Either.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- class
- Source
- Either.scala
- Supertypes
- Self type
-
Either.type
A type class for types that admit numeric literals.
A type class for types that admit numeric literals.
Attributes
- Companion
- object
- Source
- FromDigits.scala
- Supertypes
- Known subtypes
-
trait Decimal[T]trait Floating[T]object BigDecimalFromDigitstrait WithRadix[T]object BigIntFromDigits
Attributes
- Companion
- trait
- Source
- FromDigits.scala
- Supertypes
- Self type
-
FromDigits.type
The left side of the disjoint union, as opposed to the scala.util.Right side.
The left side of the disjoint union, as opposed to the scala.util.Right side.
Attributes
- Source
- Either.scala
- Supertypes
Attributes
- Source
- NotGiven.scala
- Supertypes
- Known subtypes
-
object NotGiven
A special class used to implement negation in implicit search.
A special class used to implement negation in implicit search.
Consider the problem of using implicit i1
for a query type D
if an implicit for some other class C
is available, and using an implicit i2
if no implicit value of type C
is available. If we do not want to prioritize i1
and i2
by putting them in different traits we can instead define the following:
given i1: D(using ev: C) = ... given i2: D(using ev: NotGiven[C]) = ...
NotGiven
is treated specially in implicit search, similar to the way logical negation is treated in Prolog: The implicit search for NotGiven[C]
succeeds if and only if the implicit search for C
fails.
In Scala 2 this form of negation can be simulated by setting up a conditional ambiguous implicit and an unconditional fallback, the way it is done with the default
, amb1
and amb2
methods below. Due to the way these two methods are defined, NotGiven
is also usable from Scala 2.
In Dotty, ambiguity is a global error, and therefore cannot be used to implement negation. Instead, NotGiven
is treated natively in implicit search.
Attributes
- Companion
- object
- Source
- NotGiven.scala
- Supertypes
Attributes
- Companion
- class
- Source
- NotGiven.scala
- Supertypes
- Self type
-
NotGiven.type
Loads library.properties
from the jar.
Loads library.properties
from the jar.
Attributes
- Source
- Properties.scala
- Supertypes
- Self type
-
Properties.type
Attributes
- Companion
- object
- Source
- Random.scala
- Supertypes
- Known subtypes
-
object Random
The object Random
offers a default implementation of scala.util.Random and random-related convenience methods.
The object Random
offers a default implementation of scala.util.Random and random-related convenience methods.
Attributes
- Companion
- class
- Source
- Random.scala
- Supertypes
- Self type
-
Random.type
The right side of the disjoint union, as opposed to the scala.util.Left side.
The right side of the disjoint union, as opposed to the scala.util.Left side.
Attributes
- Source
- Either.scala
- Supertypes
The Sorting
object provides convenience wrappers for java.util.Arrays.sort
.
The Sorting
object provides convenience wrappers for java.util.Arrays.sort
. Methods that defer to java.util.Arrays.sort
say that they do or under what conditions that they do.
Sorting
also implements a general-purpose quicksort and stable (merge) sort for those cases where java.util.Arrays.sort
could only be used at the cost of a large memory penalty. If performance rather than memory usage is the primary concern, one may wish to find alternate strategies to use java.util.Arrays.sort
directly e.g. by boxing primitives to use a custom ordering on them.
Sorting
provides methods where you can provide a comparison function, or can request a sort of items that are scala.math.Ordered or that otherwise have an implicit or explicit scala.math.Ordering.
Note also that high-performance non-default sorts for numeric types are not provided. If this is required, it is advisable to investigate other libraries that cover this use case.
Attributes
- Source
- Sorting.scala
- Supertypes
- Self type
-
Sorting.type
The Try
type represents a computation that may fail during evaluation by raising an exception.
The Try
type represents a computation that may fail during evaluation by raising an exception. It holds either a successfully computed value or the exception that was thrown. This is similar to the scala.util.Either type, but with different semantics.
Instances of Try[T]
are an instance of either scala.util.Success[T] or scala.util.Failure[T].
For example, consider a computation that performs division on user-defined input. Try
can reduce or eliminate the need for explicit exception handling in all of the places where an exception might be thrown.
Example:
import scala.io.StdIn
import scala.util.{Try, Success, Failure}
def divide: Try[Int] = {
val dividend = Try(StdIn.readLine("Enter an Int that you'd like to divide:\n").toInt)
val divisor = Try(StdIn.readLine("Enter an Int that you'd like to divide by:\n").toInt)
val problem = dividend.flatMap(x => divisor.map(y => x/y))
problem match {
case Success(v) =>
println("Result of " + dividend.get + "/"+ divisor.get +" is: " + v)
Success(v)
case Failure(e) =>
println("You must've divided by zero or entered something that's not an Int. Try again!")
println("Info from the exception: " + e.getMessage)
divide
}
}
An important property of Try
shown in the above example is its ability to pipeline, or chain, operations, catching exceptions along the way. The flatMap
and map
combinators in the above example each essentially pass off either their successfully completed value, wrapped in the Success
type for it to be further operated upon by the next combinator in the chain, or the exception wrapped in the Failure
type usually to be simply passed on down the chain. Combinators such as recover
and recoverWith
are designed to provide some type of default behavior in the case of failure.
Note: only non-fatal exceptions are caught by the combinators on Try
(see scala.util.control.NonFatal). Serious system errors, on the other hand, will be thrown.
Note:: all Try combinators will catch exceptions and return failure unless otherwise specified in the documentation.
Attributes
A utility for performing automatic resource management.
A utility for performing automatic resource management. It can be used to perform an operation using resources, after which it releases the resources in reverse order of their creation.
Usage
There are multiple ways to automatically manage resources with Using
. If you only need to manage a single resource, the apply
method is easiest; it wraps the resource opening, operation, and resource releasing in a Try
.
Example:
import java.io.{BufferedReader, FileReader}
import scala.util.{Try, Using}
val lines: Try[Seq[String]] =
Using(new BufferedReader(new FileReader("file.txt"))) { reader =>
Iterator.continually(reader.readLine()).takeWhile(_ != null).toSeq
}
If you need to manage multiple resources, Using.Manager
should be used. It allows the managing of arbitrarily many resources, whose creation, use, and release are all wrapped in a Try
.
Example:
import java.io.{BufferedReader, FileReader}
import scala.util.{Try, Using}
val files = List("file1.txt", "file2.txt", "file3.txt", "file4.txt")
val lines: Try[Seq[String]] = Using.Manager { use =>
// acquire resources
def mkreader(filename: String) = use(new BufferedReader(new FileReader(filename)))
// use your resources here
def lines(reader: BufferedReader): Iterator[String] =
Iterator.continually(reader.readLine()).takeWhile(_ != null)
files.map(mkreader).flatMap(lines)
}
Composed or "wrapped" resources may be acquired in order of construction, if "underlying" resources are not closed. Although redundant in this case, here is the previous example with a wrapped call to use
:
def mkreader(filename: String) = use(new BufferedReader(use(new FileReader(filename))))
Custom resources can be registered on construction by requiring an implicit Manager
. This ensures they will be released even if composition fails:
import scala.util.Using
case class X(x: String)(implicit mgr: Using.Manager) extends AutoCloseable {
override def close() = println(s"CLOSE $x")
mgr.acquire(this)
}
case class Y(y: String)(x: String)(implicit mgr: Using.Manager) extends AutoCloseable {
val xres = X(x)
override def close() = println(s"CLOSE $y")
// an error during construction releases previously acquired resources
require(y != null, "y is null")
mgr.acquire(this)
}
Using.Manager { implicit mgr =>
val y = Y("Y")("X")
println(s"USE $y")
}
println {
Using.Manager { implicit mgr =>
Y(null)("X")
}
} // Failure(java.lang.IllegalArgumentException: requirement failed: y is null)
If you wish to avoid wrapping management and operations in a Try
, you can use Using.resource
, which throws any exceptions that occur.
Example:
import java.io.{BufferedReader, FileReader}
import scala.util.Using
val lines: Seq[String] =
Using.resource(new BufferedReader(new FileReader("file.txt"))) { reader =>
Iterator.continually(reader.readLine()).takeWhile(_ != null).toSeq
}
Suppression Behavior
If two exceptions are thrown (e.g., by an operation and closing a resource), one of them is re-thrown, and the other is added to it as a suppressed exception. If the two exceptions are of different 'severities' (see below), the one of a higher severity is re-thrown, and the one of a lower severity is added to it as a suppressed exception. If the two exceptions are of the same severity, the one thrown first is re-thrown, and the one thrown second is added to it as a suppressed exception. If an exception is a ControlThrowable
, or if it does not support suppression (see Throwable
's constructor with an enableSuppression
parameter), an exception that would have been suppressed is instead discarded.
Exceptions are ranked from highest to lowest severity as follows:
-
java.lang.VirtualMachineError
-
java.lang.LinkageError
-
java.lang.InterruptedException
andjava.lang.ThreadDeath
-
fatal exceptions, excluding
scala.util.control.ControlThrowable
-
scala.util.control.ControlThrowable
-
all other exceptions
When more than two exceptions are thrown, the first two are combined and re-thrown as described above, and each successive exception thrown is combined as it is thrown.
Attributes
- Source
- Using.scala
- Supertypes
- Self type
-
Using.type
A boundary that can be exited by break
calls. boundary
and break
represent a unified and superior alternative for the scala.util.control.NonLocalReturns
and scala.util.control.Breaks
APIs. The main differences are:
A boundary that can be exited by break
calls. boundary
and break
represent a unified and superior alternative for the scala.util.control.NonLocalReturns
and scala.util.control.Breaks
APIs. The main differences are:
- Unified names:
boundary
to establish a scope,break
to leave it.break
can optionally return a value. - Integration with exceptions.
break
s are logically non-fatal exceptions. TheBreak
exception class extendsRuntimeException
and is optimized so that stack trace generation is suppressed. - Better performance: breaks to enclosing scopes in the same method can be rewritten to jumps.
Example usage:
import scala.util.boundary, boundary.break
def firstIndex[T](xs: List[T], elem: T): Int =
boundary:
for (x, i) <- xs.zipWithIndex do
if x == elem then break(i)
-1
Attributes
- Source
- boundary.scala
- Supertypes
- Self type
-
boundary.type
Adds chaining methods tap
and pipe
to every type.
Adds chaining methods tap
and pipe
to every type. See ChainingOps.
Attributes
- Source
- package.scala
- Supertypes
- Self type
-
chaining.type
Experimental classlikes
Type class relating a FunctionN[..., R]
with an equivalent tupled function Function1[TupleN[...], R]
Type class relating a FunctionN[..., R]
with an equivalent tupled function Function1[TupleN[...], R]
Type parameters
- F
-
a function type
- G
-
a tupled function type (function of arity 1 receiving a tuple as argument)
Attributes
- Experimental
- true
- Source
- TupledFunction.scala
- Supertypes