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.
- Alphabetic
- By Inheritance
- walk
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
preOrderto betrueso 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
preOrderto betrueso 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- object stream
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated