Class/Object

fs2.io

Watcher

Related Docs: object Watcher | package io

Permalink

sealed abstract class Watcher[F[_]] extends AnyRef

Allows watching the file system for changes to directories and files by using the platform's WatchService.

Source
Watcher.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Watcher
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def events(pollTimeout: FiniteDuration = 1.second): Stream[F, Event]

    Permalink

    Stream of events for paths that have been registered or watched.

    Stream of events for paths that have been registered or watched.

    pollTimeout

    amount of time for which the underlying platform is polled for events

  2. abstract def register(path: Path, types: Seq[EventType] = Nil, modifiers: Seq[Modifier] = Nil): F[F[Unit]]

    Permalink

    Registers for events on the specified path.

    Registers for events on the specified path.

    This is a low-level abstraction on the platform's Path#register. The supplied path must be a directory and events are raised for only direct descendants of the path. Use watch for a higher level API.

    Returns a cancellation task that unregisters the path for events. Unregistration is optional - the Watcher will free all resources when it is finalized. Unregistration is only needed when a Watcher will continue to be used after unregistration.

    path

    directory to watch for events

    types

    event types to register for; if Nil, all standard event types are registered

    modifiers

    modifiers to pass to the underlying WatchService when registering

    returns

    unregistration task

  3. abstract def watch(path: Path, types: Seq[EventType] = Nil, modifiers: Seq[Modifier] = Nil): F[F[Unit]]

    Permalink

    Registers for events on the specified path.

    Registers for events on the specified path.

    This is more feature-rich than the platform's Path#register. The supplied path may be a file or directory and events may raised for all descendants of the path. Use register for a lower-level API.

    Returns a cancellation task that unregisters the path for events. Unregistration is optional - the Watcher will free all resources when it is finalized. Unregistration is only needed when a Watcher will continue to be used after unregistration.

    path

    file or directory to watch for events

    types

    event types to register for; if Nil, all standard event types are registered

    modifiers

    modifiers to pass to the underlying WatchService when registering

    returns

    unregistration task

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Watcher[F] to any2stringadd[Watcher[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Watcher[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Watcher[F] to ArrowAssoc[Watcher[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def ensuring(cond: (Watcher[F]) ⇒ Boolean, msg: ⇒ Any): Watcher[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Watcher[F] to Ensuring[Watcher[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (Watcher[F]) ⇒ Boolean): Watcher[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Watcher[F] to Ensuring[Watcher[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): Watcher[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Watcher[F] to Ensuring[Watcher[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): Watcher[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Watcher[F] to Ensuring[Watcher[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

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

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Watcher[F] to StringFormat[Watcher[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

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

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

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

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

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

  27. def →[B](y: B): (Watcher[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Watcher[F] to ArrowAssoc[Watcher[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Watcher[F] to any2stringadd[Watcher[F]]

Inherited by implicit conversion StringFormat from Watcher[F] to StringFormat[Watcher[F]]

Inherited by implicit conversion Ensuring from Watcher[F] to Ensuring[Watcher[F]]

Inherited by implicit conversion ArrowAssoc from Watcher[F] to ArrowAssoc[Watcher[F]]

Ungrouped