Options that customize a filesystem walk via Files[F].walk.
Attributes
- Companion
- object
- Source
- WalkOptions.scala
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Abstract methods
Indicates whether to allow cycles when following links.
Indicates whether to allow cycles when following links. If true, any link causing a cycle is emitted as the link path. If false, a cycle results in walk failing with a FileSystemLoopException.
Attributes
- Source
- WalkOptions.scala
Size of chunks emitted from the walk.
Size of chunks emitted from the walk.
Implementations *may* use this for optimization, batching file system operations.
A chunk size of 1 hints to the implementation to use the maximally laziness in file system access, emitting a single path at a time.
A chunk size of Int.MaxValue hints to the implementation to perform all file system operations at once, emitting a single chunk with all paths.
Attributes
- Source
- WalkOptions.scala
Indicates whether links are followed during the walk.
Indicates whether links are followed during the walk. If false, the path of each link is emitted. If true, links are followed and their contents are emitted.
Attributes
- Source
- WalkOptions.scala
Maximum depth to walk.
Maximum depth to walk. A value of 0 results in emitting just the starting path. A value of 1 results in emitting the starting path and all direct descendants.
Attributes
- Source
- WalkOptions.scala
Returns a new WalkOptions with the specified value for allowCycles.
Returns a new WalkOptions with the specified value for allowCycles.
Attributes
- Source
- WalkOptions.scala
Returns a new WalkOptions with the specified chunk size.
Returns a new WalkOptions with the specified value for followLinks.
Returns a new WalkOptions with the specified value for followLinks.
Attributes
- Source
- WalkOptions.scala
Returns a new WalkOptions with the specified max depth.