Class

sclib.io.fs

FSIterator

Related Doc: package fs

Permalink

case class FSIterator(start: FSDir, depth: Int = Integer.MAX_VALUE, includeStartDir: Boolean = false) extends Iterator[Try[FSEntryImpl]] with Product with Serializable

a save file-system iterator.

it wraps every file operation in a Try.

by default, the iterator start in the given directory, and walk recursively (deep first) over all entries. you can control the recursive level with the 'depth' argument, where 1 means only the content from the given directory. to start with the given directory, use 'includeStartDir = true'.

assume the following directory tree: 

/tmp/sclib-example/a1/b1/a1b1file
/tmp/sclib-example/a1/b1/c1/a1b1c1file
/tmp/sclib-example/a2/b2/a2b2file

default behaviour

scala> FSIterator(dir("/tmp/sclib-example").get).foreach(println)
Success(FSDir(/tmp/sclib-example/a1))
Success(FSDir(/tmp/sclib-example/a1/b1))
Success(FSFile(/tmp/sclib-example/a1/b1/a1b1file))
Success(FSDir(/tmp/sclib-example/a1/b1/c1))
Success(FSFile(/tmp/sclib-example/a1/b1/c1/a1b1c1file))
Success(FSDir(/tmp/sclib-example/a2))
Success(FSDir(/tmp/sclib-example/a2/b2))
Success(FSFile(/tmp/sclib-example/a2/b2/a2b2file))

with max-depth: 2 and the start directory included

scala> FSIterator(dir("/tmp/sclib-example").get, depth = 2, includeStartDir = true).foreach(println)
Success(FSDir(/tmp/sclib-example))
Success(FSDir(/tmp/sclib-example/a1))
Success(FSDir(/tmp/sclib-example/a1/b1))
Success(FSDir(/tmp/sclib-example/a2))
Success(FSDir(/tmp/sclib-example/a2/b2))

start

directory to start

depth

the maximum number of directory levels to visit

Linear Supertypes
Serializable, Serializable, Product, Equals, Iterator[Try[FSEntryImpl]], TraversableOnce[Try[FSEntryImpl]], GenTraversableOnce[Try[FSEntryImpl]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FSIterator
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Iterator
  7. TraversableOnce
  8. GenTraversableOnce
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FSIterator(start: FSDir, depth: Int = Integer.MAX_VALUE, includeStartDir: Boolean = false)

    Permalink

    start

    directory to start

    depth

    the maximum number of directory levels to visit

Type Members

  1. class GroupedIterator[B >: A] extends AbstractIterator[Seq[B]] with Iterator[Seq[B]]

    Permalink
    Definition Classes
    Iterator

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def ++[B >: Try[FSEntryImpl]](that: ⇒ GenTraversableOnce[B]): Iterator[B]

    Permalink
    Definition Classes
    Iterator

  4. def /:[B](z: B)(op: (B, Try[FSEntryImpl]) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  5. def :\[B](z: B)(op: (Try[FSEntryImpl], B) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  7. def addString(b: StringBuilder): StringBuilder

    Permalink
    Definition Classes
    TraversableOnce

  8. def addString(b: StringBuilder, sep: String): StringBuilder

    Permalink
    Definition Classes
    TraversableOnce

  9. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

    Permalink
    Definition Classes
    TraversableOnce

  10. def aggregate[B](z: ⇒ B)(seqop: (B, Try[FSEntryImpl]) ⇒ B, combop: (B, B) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  12. def buffered: BufferedIterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator

  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  14. def collect[B](pf: PartialFunction[Try[FSEntryImpl], B]): Iterator[B]

    Permalink
    Definition Classes
    Iterator
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) collect has changed. The previous behavior can be reproduced with toSeq.

  15. def collectFirst[B](pf: PartialFunction[Try[FSEntryImpl], B]): Option[B]

    Permalink
    Definition Classes
    TraversableOnce

  16. def contains(elem: Any): Boolean

    Permalink
    Definition Classes
    Iterator

  17. def copyToArray[B >: Try[FSEntryImpl]](xs: Array[B], start: Int, len: Int): Unit

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce

  18. def copyToArray[B >: Try[FSEntryImpl]](xs: Array[B]): Unit

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  19. def copyToArray[B >: Try[FSEntryImpl]](xs: Array[B], start: Int): Unit

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  20. def copyToBuffer[B >: Try[FSEntryImpl]](dest: Buffer[B]): Unit

    Permalink
    Definition Classes
    TraversableOnce

  21. def corresponds[B](that: GenTraversableOnce[B])(p: (Try[FSEntryImpl], B) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    Iterator

  22. def count(p: (Try[FSEntryImpl]) ⇒ Boolean): Int

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  23. val depth: Int

    Permalink

    the maximum number of directory levels to visit

  24. def drop(n: Int): Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator

  25. def dropWhile(p: (Try[FSEntryImpl]) ⇒ Boolean): Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator

  26. def duplicate: (Iterator[Try[FSEntryImpl]], Iterator[Try[FSEntryImpl]])

    Permalink
    Definition Classes
    Iterator

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

    Permalink
    Definition Classes
    AnyRef

  28. def exists(p: (Try[FSEntryImpl]) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce

  29. def filter(p: (Try[FSEntryImpl]) ⇒ Boolean): Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator

  30. def filterNot(p: (Try[FSEntryImpl]) ⇒ Boolean): Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator

  31. def finalize(): Unit

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

  32. def find(p: (Try[FSEntryImpl]) ⇒ Boolean): Option[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce

  33. def flatMap[B](f: (Try[FSEntryImpl]) ⇒ GenTraversableOnce[B]): Iterator[B]

    Permalink
    Definition Classes
    Iterator

  34. def fold[A1 >: Try[FSEntryImpl]](z: A1)(op: (A1, A1) ⇒ A1): A1

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  35. def foldLeft[B](z: B)(op: (B, Try[FSEntryImpl]) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  36. def foldRight[B](z: B)(op: (Try[FSEntryImpl], B) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  37. def forall(p: (Try[FSEntryImpl]) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce

  38. def foreach[U](f: (Try[FSEntryImpl]) ⇒ U): Unit

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce

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

    Permalink
    Definition Classes
    AnyRef → Any

  40. def grouped[B >: Try[FSEntryImpl]](size: Int): GroupedIterator[B]

    Permalink
    Definition Classes
    Iterator

  41. def hasDefiniteSize: Boolean

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce

  42. def hasNext: Boolean

    Permalink
    Definition Classes
    FSIterator → Iterator

  43. val includeStartDir: Boolean

    Permalink

  44. def indexOf[B >: Try[FSEntryImpl]](elem: B): Int

    Permalink
    Definition Classes
    Iterator

  45. def indexWhere(p: (Try[FSEntryImpl]) ⇒ Boolean): Int

    Permalink
    Definition Classes
    Iterator

  46. def isEmpty: Boolean

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce

  47. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  48. def isTraversableAgain: Boolean

    Permalink
    Definition Classes
    Iterator → GenTraversableOnce

  49. def length: Int

    Permalink
    Definition Classes
    Iterator

  50. def map[B](f: (Try[FSEntryImpl]) ⇒ B): Iterator[B]

    Permalink
    Definition Classes
    Iterator

  51. def max[B >: Try[FSEntryImpl]](implicit cmp: Ordering[B]): Try[FSEntryImpl]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  52. def maxBy[B](f: (Try[FSEntryImpl]) ⇒ B)(implicit cmp: Ordering[B]): Try[FSEntryImpl]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  53. def min[B >: Try[FSEntryImpl]](implicit cmp: Ordering[B]): Try[FSEntryImpl]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  54. def minBy[B](f: (Try[FSEntryImpl]) ⇒ B)(implicit cmp: Ordering[B]): Try[FSEntryImpl]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  55. def mkString: String

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  56. def mkString(sep: String): String

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  57. def mkString(start: String, sep: String, end: String): String

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  58. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  59. def next(): Try[FSEntryImpl]

    Permalink
    Definition Classes
    FSIterator → Iterator

  60. def nonEmpty: Boolean

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  61. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  62. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  63. def padTo[A1 >: Try[FSEntryImpl]](len: Int, elem: A1): Iterator[A1]

    Permalink
    Definition Classes
    Iterator

  64. def partition(p: (Try[FSEntryImpl]) ⇒ Boolean): (Iterator[Try[FSEntryImpl]], Iterator[Try[FSEntryImpl]])

    Permalink
    Definition Classes
    Iterator

  65. def patch[B >: Try[FSEntryImpl]](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]

    Permalink
    Definition Classes
    Iterator

  66. def product[B >: Try[FSEntryImpl]](implicit num: Numeric[B]): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  67. def reduce[A1 >: Try[FSEntryImpl]](op: (A1, A1) ⇒ A1): A1

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  68. def reduceLeft[B >: Try[FSEntryImpl]](op: (B, Try[FSEntryImpl]) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce

  69. def reduceLeftOption[B >: Try[FSEntryImpl]](op: (B, Try[FSEntryImpl]) ⇒ B): Option[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  70. def reduceOption[A1 >: Try[FSEntryImpl]](op: (A1, A1) ⇒ A1): Option[A1]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  71. def reduceRight[B >: Try[FSEntryImpl]](op: (Try[FSEntryImpl], B) ⇒ B): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  72. def reduceRightOption[B >: Try[FSEntryImpl]](op: (Try[FSEntryImpl], B) ⇒ B): Option[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  73. def reversed: List[Try[FSEntryImpl]]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    TraversableOnce

  74. def sameElements(that: Iterator[_]): Boolean

    Permalink
    Definition Classes
    Iterator

  75. def scanLeft[B](z: B)(op: (B, Try[FSEntryImpl]) ⇒ B): Iterator[B]

    Permalink
    Definition Classes
    Iterator

  76. def scanRight[B](z: B)(op: (Try[FSEntryImpl], B) ⇒ B): Iterator[B]

    Permalink
    Definition Classes
    Iterator

  77. def seq: Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce

  78. def size: Int

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  79. def slice(from: Int, until: Int): Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator

  80. def sliding[B >: Try[FSEntryImpl]](size: Int, step: Int): GroupedIterator[B]

    Permalink
    Definition Classes
    Iterator

  81. def span(p: (Try[FSEntryImpl]) ⇒ Boolean): (Iterator[Try[FSEntryImpl]], Iterator[Try[FSEntryImpl]])

    Permalink
    Definition Classes
    Iterator

  82. val start: FSDir

    Permalink

    directory to start

  83. def sum[B >: Try[FSEntryImpl]](implicit num: Numeric[B]): B

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  84. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  85. def take(n: Int): Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator

  86. def takeWhile(p: (Try[FSEntryImpl]) ⇒ Boolean): Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator

  87. def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, Try[FSEntryImpl], Col[Try[FSEntryImpl]]]): Col[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  88. def toArray[B >: Try[FSEntryImpl]](implicit arg0: ClassTag[B]): Array[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  89. def toBuffer[B >: Try[FSEntryImpl]]: Buffer[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  90. def toIndexedSeq: IndexedSeq[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  91. def toIterable: Iterable[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  92. def toIterator: Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator → GenTraversableOnce

  93. def toList: List[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  94. def toMap[T, U](implicit ev: <:<[Try[FSEntryImpl], (T, U)]): Map[T, U]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  95. def toSeq: Seq[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  96. def toSet[B >: Try[FSEntryImpl]]: Set[B]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  97. def toStream: Stream[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator → GenTraversableOnce

  98. def toString(): String

    Permalink
    Definition Classes
    Iterator → AnyRef → Any

  99. def toTraversable: Traversable[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator → TraversableOnce → GenTraversableOnce

  100. def toVector: Vector[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    TraversableOnce → GenTraversableOnce

  101. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  102. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  103. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  104. def withFilter(p: (Try[FSEntryImpl]) ⇒ Boolean): Iterator[Try[FSEntryImpl]]

    Permalink
    Definition Classes
    Iterator

  105. def zip[B](that: Iterator[B]): Iterator[(Try[FSEntryImpl], B)]

    Permalink
    Definition Classes
    Iterator

  106. def zipAll[B, A1 >: Try[FSEntryImpl], B1 >: B](that: Iterator[B], thisElem: A1, thatElem: B1): Iterator[(A1, B1)]

    Permalink
    Definition Classes
    Iterator

  107. def zipWithIndex: Iterator[(Try[FSEntryImpl], Int)]

    Permalink
    Definition Classes
    Iterator

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Iterator[Try[FSEntryImpl]]

Inherited from TraversableOnce[Try[FSEntryImpl]]

Inherited from GenTraversableOnce[Try[FSEntryImpl]]

Inherited from AnyRef

Inherited from Any

Ungrouped