Packages

object Using

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

Type Members

  1. trait Resource[-R] extends AnyRef

    A typeclass describing a resource which can be released.

    A typeclass describing a resource which can be released.

    R

    the type of the resource

Value Members

  1. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  4. def apply[R](resource: ⇒ R): Using[R]

    Creates a Using from the given resource.

    Creates a Using from the given resource.

    Note

    If the resource does not have an implicit Resource in scope, the returned Using will be useless.

  5. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver object is not an instance of the erasure of type T0.

  6. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws(classOf[java.lang.CloneNotSupportedException])
    Note

    not specified by SLS as a member of AnyRef

  7. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (that) is a reference to the receiver object (this).

    Tests whether the argument (that) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
    Note

    not specified by SLS as a member of AnyRef

  10. final def getClass(): Class[_]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

    a class object corresponding to the runtime type of the receiver.

    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Annotations
    @native()
    Note

    not specified by SLS as a member of AnyRef

  15. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Annotations
    @native()
    Note

    not specified by SLS as a member of AnyRef

  16. def resource[R, A](resource: R)(body: (R) ⇒ A)(implicit arg0: Resource[R]): A

    Performs an operation using a resource, and then releases the resource, even if the operation throws an exception.

    Performs an operation using a resource, and then releases the resource, even if the operation throws an exception. This method behaves similarly to Java's try-with-resources.

    It is highly recommended to use the Using construct, which safely wraps resource usage and management in a Try.

    If both the operation and releasing the resource throw exceptions, the one thrown when releasing the resource is added as a suppressed exception to the one thrown by the operation, unless the exception thrown when releasing the resource is fatal, and the one thrown by the operation is not. In that case, the exception thrown by the operation is added as a suppressed exception to the one thrown when releasing the resource. If an exception is a ControlThrowable, no exception will be added to it as a suppressed exception.

    R

    the type of the resource

    A

    the return type of the operation

    resource

    the resource

    body

    the operation to perform with the resource

    returns

    the result of the operation, if neither the operation nor releasing the resource throws

  17. def resources[R1, R2, R3, R4, A](resource1: R1, resource2: ⇒ R2, resource3: ⇒ R3, resource4: ⇒ R4)(body: (R1, R2, R3, R4) ⇒ A)(implicit arg0: Resource[R1], arg1: Resource[R2], arg2: Resource[R3], arg3: Resource[R4]): A

    Performs an operation using four resources, and then releases the resources in reverse order, even if the operation throws an exception.

    Performs an operation using four resources, and then releases the resources in reverse order, even if the operation throws an exception. This method behaves similarly to Java's try-with-resources.

    It is highly recommended to use the Using construct, which safely wraps resource usage and management in a Try.

    If more than one exception is thrown by the operation and releasing resources, the exception thrown first is thrown, with the other exceptions added as suppressed exceptions to the one thrown first. This is the case unless a later exception is fatal, and the one preceding it is not. In that case, the first exception is added as a suppressed exception to the fatal one, and the fatal one is thrown. If an exception is a ControlThrowable, no exception will be added to it as a suppressed exception.

    R1

    the type of the first resource

    R2

    the type of the second resource

    R3

    the type of the third resource

    R4

    the type of the fourth resource

    A

    the return type of the operation

    resource1

    the first resource

    resource2

    the second resource

    resource3

    the third resource

    resource4

    the fourth resource

    body

    the operation to perform using the resources

    returns

    the result of the operation, if neither the operation nor releasing the resources throws

  18. def resources[R1, R2, R3, A](resource1: R1, resource2: ⇒ R2, resource3: ⇒ R3)(body: (R1, R2, R3) ⇒ A)(implicit arg0: Resource[R1], arg1: Resource[R2], arg2: Resource[R3]): A

    Performs an operation using three resources, and then releases the resources in reverse order, even if the operation throws an exception.

    Performs an operation using three resources, and then releases the resources in reverse order, even if the operation throws an exception. This method behaves similarly to Java's try-with-resources.

    It is highly recommended to use the Using construct, which safely wraps resource usage and management in a Try.

    If more than one exception is thrown by the operation and releasing resources, the exception thrown first is thrown, with the other exceptions added as suppressed exceptions to the one thrown first. This is the case unless a later exception is fatal, and the one preceding it is not. In that case, the first exception is added as a suppressed exception to the fatal one, and the fatal one is thrown. If an exception is a ControlThrowable, no exception will be added to it as a suppressed exception.

    R1

    the type of the first resource

    R2

    the type of the second resource

    R3

    the type of the third resource

    A

    the return type of the operation

    resource1

    the first resource

    resource2

    the second resource

    resource3

    the third resource

    body

    the operation to perform using the resources

    returns

    the result of the operation, if neither the operation nor releasing the resources throws

  19. def resources[R1, R2, A](resource1: R1, resource2: ⇒ R2)(body: (R1, R2) ⇒ A)(implicit arg0: Resource[R1], arg1: Resource[R2]): A

    Performs an operation using two resources, and then releases the resources in reverse order, even if the operation throws an exception.

    Performs an operation using two resources, and then releases the resources in reverse order, even if the operation throws an exception. This method behaves similarly to Java's try-with-resources.

    It is highly recommended to use the Using construct, which safely wraps resource usage and management in a Try.

    If more than one exception is thrown by the operation and releasing resources, the exception thrown first is thrown, with the other exceptions added as suppressed exceptions to the one thrown first. This is the case unless a later exception is fatal, and the one preceding it is not. In that case, the first exception is added as a suppressed exception to the fatal one, and the fatal one is thrown. If an exception is a ControlThrowable, no exception will be added to it as a suppressed exception.

    R1

    the type of the first resource

    R2

    the type of the second resource

    A

    the return type of the operation

    resource1

    the first resource

    resource2

    the second resource

    body

    the operation to perform using the resources

    returns

    the result of the operation, if neither the operation nor releasing the resources throws

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws(classOf[java.lang.InterruptedException])
  25. object Resource

Inherited from AnyRef

Inherited from Any

Ungrouped