W3cubDocs

/Scala 2.13 Library

Class scala.util.ChainingOps

final class ChainingOps[A] extends AnyVal

Adds chaining methods tap and pipe to every type.

Source
ChainingOps.scala
Linear Supertypes
AnyVal, Any

Instance Constructors

new ChainingOps(self: A)

Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.

returns

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

Definition Classes
Any

final def ##(): Int

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
Any

def +(other: String): String

Implicit
This member is added by an implicit conversion from ChainingOps[A] toany2stringadd[ChainingOps[A]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd

def ->[B](y: B): (ChainingOps[A], B)

Implicit
This member is added by an implicit conversion from ChainingOps[A] toArrowAssoc[ChainingOps[A]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()

final def ==(arg0: Any): Boolean

Test two objects for equality. 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
Any

final def asInstanceOf[T0]: 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.

def ensuring(cond: (ChainingOps[A]) => Boolean, msg: => Any): ChainingOps[A]

Implicit
This member is added by an implicit conversion from ChainingOps[A] toEnsuring[ChainingOps[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (ChainingOps[A]) => Boolean): ChainingOps[A]

Implicit
This member is added by an implicit conversion from ChainingOps[A] toEnsuring[ChainingOps[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean, msg: => Any): ChainingOps[A]

Implicit
This member is added by an implicit conversion from ChainingOps[A] toEnsuring[ChainingOps[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): ChainingOps[A]

Implicit
This member is added by an implicit conversion from ChainingOps[A] toEnsuring[ChainingOps[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def formatted(fmtstr: String): String

Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

Implicit
This member is added by an implicit conversion from ChainingOps[A] toStringFormat[ChainingOps[A]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def getClass(): Class[_ <: AnyVal]

Returns the runtime class representation of the object.

returns

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

Definition Classes
AnyValAny

final def isInstanceOf[T0]: Boolean

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

def pipe[B](f: (A) => B): B

Converts the value by applying the function f.

scala> import scala.util.chaining._

scala> val times6 = (_: Int) * 6
times6: Int => Int = $$Lambda$2023/[email protected]

scala> val i = (1 - 2 - 3).pipe(times6).pipe(scala.math.abs)
i: Int = 24

Note: (1 - 2 - 3).pipe(times6) may have a small amount of overhead at runtime compared to the equivalent { val temp = 1 - 2 - 3; times6(temp) }.

B

the result type of the function f.

f

the function to apply to the value.

returns

a new value resulting from applying the given function f to this value.

def tap[U](f: (A) => U): A

Applies f to the value for its side effects, and returns the original value.

scala> import scala.util.chaining._

scala> val xs = List(1, 2, 3).tap(ys => println("debug " + ys.toString))
debug List(1, 2, 3)
xs: List[Int] = List(1, 2, 3)
U

the result type of the function f.

f

the function to apply to the value.

returns

the original value self.

def toString(): String

Returns a string representation of the object.

The default representation is platform dependent.

returns

a string representation of the object.

Definition Classes
Any

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/util/ChainingOps.html