Packages

trait ResourceIterator[+A] extends VersionSpecificResourceIterator[A] with java.io.Closeable

Offers iterator-like access to IO resources.

For the most part, values of type ResourceIterator can be considered as iterators, with a few improvements.

First, they have a ResourceIterator.close()* method, which allows you to release the underlying resource when needed. This is fairly important and part of the reason why working with Source.getLines can be so aggravating.

Second, ResourceIterator.close()* is mostly not needed: whenever an IO error occurs or the underlying resource is empty, it will be closed automatically. Provided you intend to read the whole resource, you never need to explicitly close it. This covers non-obvious cases such as filtering or dropping elements.

You should be able to express most common causes for not reading the entire stream through standard combinators. For example, "take the first n elements" is take(n), or "take all odd elements" is filter(_ % 2 == 0). This allows you to ignore the fact that the underlying resource needs to be closed. Should you ever find youself in a situation when you just want to stop, however, ResourceIterator.close()* is available.

Self Type
ResourceIterator[A]
Annotations
@SuppressWarnings()
Source
ResourceIterator.scala
Linear Supertypes
java.io.Closeable, AutoCloseable, VersionSpecificResourceIterator[A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResourceIterator
  2. Closeable
  3. AutoCloseable
  4. VersionSpecificResourceIterator
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def checkNext: Boolean

    Checks whether there are still elements to read in the underlying resource.

    Checks whether there are still elements to read in the underlying resource.

    This method must be pure: it's expected not to have side effects and never to throw exceptions.

    Attributes
    protected
  2. abstract def readNext(): A

    Reads the next element in the underlying resource

    Reads the next element in the underlying resource

    This method is by definition side-effecting and allowed to throw exceptions.

    Attributes
    protected
  3. abstract def release(): Unit

    Releases the underlying resource.

    Releases the underlying resource.

    While this method is side-effecting and allowed to throw exceptions, the current implementation will simply swallow them.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def close(): Unit
    Definition Classes
    ResourceIterator → Closeable → AutoCloseable
  7. def collect[B](f: PartialFunction[A, B]): ResourceIterator[B]
  8. def drop(n: Int): ResourceIterator[A]

    Drops the next n elements from the resource.

    Drops the next n elements from the resource.

    If the resource contains m elements such that m < n, then only m elements will be dropped.

    No element will be consumed until the next next call.

  9. def dropWhile(p: (A) => Boolean): ResourceIterator[A]

    Drops elements from the resource until one is found that doesn't verify p or the resource is empty.

    Drops elements from the resource until one is found that doesn't verify p or the resource is empty.

    No element will be consumed until the next next call.

  10. def emap[E, S, B](f: (S) => Either[E, B])(implicit ev: <:<[A, Either[E, S]]): ResourceIterator[Either[E, B]]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def exists(p: (A) => Boolean): Boolean
  14. def filter(p: (A) => Boolean): ResourceIterator[A]
  15. def filterNot(pred: (A) => Boolean): ResourceIterator[A]
  16. def filterResult[E, S](p: (S) => Boolean)(implicit ev: <:<[A, Either[E, S]]): ResourceIterator[A]
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. def find(p: (A) => Boolean): Option[A]
  19. def flatMap[B](f: (A) => ResourceIterator[B]): ResourceIterator[B]
  20. def foldLeft[B](empty: B)(f: (B, A) => B): B
  21. def forall(p: (A) => Boolean): Boolean
  22. def foreach[U](f: (A) => U): Unit
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hasDefiniteSize: Boolean
  25. final def hasNext: Boolean
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def isEmpty: Boolean
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def isTraversableAgain: Boolean
  30. def iterator: Iterator[A]
    Definition Classes
    VersionSpecificResourceIterator
  31. def map[B](f: (A) => B): ResourceIterator[B]
  32. def mapResult[E, S, B](f: (S) => B)(implicit ev: <:<[A, Either[E, S]]): ResourceIterator[Either[E, B]]

    Applies the specified function to the Right case of the underlying Either.

  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def next(): A
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. def safe[F](empty: => F)(f: (Throwable) => F): ResourceIterator[Either[F, A]]

    Makes the current kantan.codecs.resource.ResourceIterator safe.

    Makes the current kantan.codecs.resource.ResourceIterator safe.

    This is achieved by catching all non-fatal exceptions and passing them to the specified f to turn into a failure type.

    This is meant to be used by the various kantan.* libraries that offer stream-like APIs: it allows them to wrap IO in a safe iterator and focus on dealing with decoding.

    empty

    error value for when next is called on an empty iterator.

    f

    used to turn non-fatal exceptions into error types.

  38. def scanLeft[B](z: B)(f: (B, A) => B): ResourceIterator[B]
  39. def slice(from: Int, until: Int): ResourceIterator[A]
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def take(n: Int): ResourceIterator[A]

    Restrict this resource to the next n elements, dropping whatever is left.

  42. def takeWhile(p: (A) => Boolean): ResourceIterator[A]

    Considers this resource to be empty as soon as an element is found that doesn't verify p.

  43. def to[F](factory: Factory[A, F]): F
    Definition Classes
    VersionSpecificResourceIterator
  44. def toBuffer[AA >: A]: Buffer[AA]
    Definition Classes
    VersionSpecificResourceIterator
  45. def toIndexedSeq: IndexedSeq[A]
    Definition Classes
    VersionSpecificResourceIterator
  46. def toIterable: Iterable[A]
    Definition Classes
    VersionSpecificResourceIterator
  47. def toList: List[A]
    Definition Classes
    VersionSpecificResourceIterator
  48. def toSeq: Seq[A]
    Definition Classes
    VersionSpecificResourceIterator
  49. def toSet[AA >: A]: Set[AA]
    Definition Classes
    VersionSpecificResourceIterator
  50. def toString(): String
    Definition Classes
    AnyRef → Any
  51. def toVector: Vector[A]
    Definition Classes
    VersionSpecificResourceIterator
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  55. def withClose(f: () => Unit): ResourceIterator[A]

    Calls the specified function when the underlying resource is empty.

  56. def withFilter(p: (A) => Boolean): ResourceIterator[A]
  57. def zipWithIndex: ResourceIterator[(A, Int)]

Deprecated Value Members

  1. def flatMapResult[E, S, B](f: (S) => Either[E, B])(implicit ev: <:<[A, Either[E, S]]): ResourceIterator[Either[E, B]]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.2.2) Use emap instead

Inherited from java.io.Closeable

Inherited from AutoCloseable

Inherited from VersionSpecificResourceIterator[A]

Inherited from AnyRef

Inherited from Any

Ungrouped