Packages

sealed trait WalkOptions extends AnyRef

Options that customize a filesystem walk via Files[F].walk.

Source
WalkOptions.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WalkOptions
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def allowCycles: Boolean

    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.

  2. abstract def chunkSize: Int

    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.

  3. abstract def followLinks: Boolean

    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.

  4. abstract def maxDepth: Int

    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.

  5. abstract def withAllowCycles(value: Boolean): WalkOptions

    Returns a new WalkOptions with the specified value for allowCycles.

  6. abstract def withChunkSize(chunkSize: Int): WalkOptions

    Returns a new WalkOptions with the specified chunk size.

  7. abstract def withFollowLinks(value: Boolean): WalkOptions

    Returns a new WalkOptions with the specified value for followLinks.

  8. abstract def withMaxDepth(maxDepth: Int): WalkOptions

    Returns a new WalkOptions with the specified max depth.

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]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped