o

os

walk

object walk

Recursively walks the given folder and returns the paths of every file or folder within.

You can pass in a skip callback to skip files or folders you are not interested in. This can avoid walking entire parts of the folder hierarchy, saving time as compared to filtering them after the fact.

By default, the paths are returned as a pre-order traversal: the enclosing folder is occurs first before any of it's contents. You can pass in preOrder = false to turn it into a post-order traversal, such that the enclosing folder occurs last after all it's contents.

os.walk returns but does not follow symlinks; pass in followLinks = true to override that behavior. You can also specify a maximum depth you wish to walk via the maxDepth parameter.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. walk
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def apply(path: Path, skip: (Path) ⇒ Boolean = _ => false, preOrder: Boolean = true, followLinks: Boolean = false, maxDepth: Int = Int.MaxValue, includeTarget: Boolean = false): IndexedSeq[Path]

    path

    the root path whose contents you wish to walk

    skip

    Skip certain files or folders from appearing in the output. If you skip a folder, its entire subtree is ignored

    preOrder

    Whether you want a folder to appear before or after its contents in the final sequence. e.g. if you're deleting them recursively you want it to be false so the folder gets deleted last, but if you're copying them recursively you want preOrder to be true so the folder gets created first.

    followLinks

    Whether or not to follow symlinks while walking; defaults to false

    maxDepth

    The max depth of the tree you wish to walk; defaults to unlimited

    includeTarget

    Whether or not to include the given path as part of the walk. If true, does not raise an error if the given path is a simple file and not a folder

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def attrs(path: Path, skip: (Path, StatInfo) ⇒ Boolean = (_, _) => false, preOrder: Boolean = true, followLinks: Boolean = false, maxDepth: Int = Int.MaxValue, includeTarget: Boolean = false): IndexedSeq[(Path, StatInfo)]

    path

    the root path whose contents you wish to walk

    skip

    Skip certain files or folders from appearing in the output. If you skip a folder, its entire subtree is ignored

    preOrder

    Whether you want a folder to appear before or after its contents in the final sequence. e.g. if you're deleting them recursively you want it to be false so the folder gets deleted last, but if you're copying them recursively you want preOrder to be true so the folder gets created first.

    followLinks

    Whether or not to follow symlinks while walking; defaults to false

    maxDepth

    The max depth of the tree you wish to walk; defaults to unlimited

    includeTarget

    Whether or not to include the given path as part of the walk. If true, does not raise an error if the given path is a simple file and not a folder

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. object stream

Inherited from AnyRef

Inherited from Any

Ungrouped