Packages

o

sbt.nio

Watch

object Watch

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

Type Members

  1. sealed trait Action extends AnyRef

    This trait is used to control the state of Watch.

    This trait is used to control the state of Watch. The Watch.Trigger action indicates that Watch should re-run the input task. The Watch.CancelWatch actions indicate that Watch should exit and return the Watch.CancelWatch instance that caused the function to exit. The Watch.Ignore action is used to indicate that the method should keep polling for new actions.

  2. sealed trait CancelWatch extends Action

    Action that indicates that the watch should stop.

  3. sealed trait ContinueWatch extends Action

    Action that does not terminate the watch but might trigger a build.

  4. final class Creation extends Event with Impl
  5. trait Custom extends CancelWatch

    A user defined Action.

    A user defined Action. It is not sealed so that the user can create custom instances. If the onStart or nextAction function passed into Watch returns Watch.Custom, then the watch will terminate.

  6. final class Deletion extends Event with Impl
  7. sealed trait Event extends AnyRef

    Represents a file event that has been detected during a continuous build.

  8. sealed class HandleError extends CancelWatch

    Action that indicates that an error has occurred.

    Action that indicates that an error has occurred. The watch will be terminated when this action is produced.

  9. sealed trait Ignore extends ContinueWatch

    Action that indicates that the watch should continue as though nothing happened.

    Action that indicates that the watch should continue as though nothing happened. This may be because, for example, no user input was yet available. This trait can be used when we don't want to take action but we do want to perform a side effect like printing options to the terminal.

  10. trait InputOption extends AnyRef
  11. final class Run extends CancelWatch

    Action that indicates that we should exit and run the provided command.

  12. final class Update extends Event with Impl

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(initialCount: Int, task: (Int) ⇒ Unit, onStart: NextAction, nextAction: NextAction, recursive: Boolean): Action

    Runs a task and then blocks until the task is ready to run again or we no longer wish to block execution.

    Runs a task and then blocks until the task is ready to run again or we no longer wish to block execution.

    task

    the aggregated task to run with each iteration

    onStart

    function to be invoked before we start polling for events

    nextAction

    function that returns the next state transition Watch.Action.

    returns

    the exit Watch.Action that can be used to potentially modify the build state and the count of the number of iterations that were run. If

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final val clearScreen: () ⇒ Unit

    Clears the console screen when evaluated.

  7. final val clearScreenOnTrigger: (Int, Path, Seq[String]) ⇒ Option[String]

    A function that first clears the screen and then returns the default on trigger message.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. final val defaultAntiEntropy: FiniteDuration

    The minimum delay between build triggers for the same file.

    The minimum delay between build triggers for the same file. If the file is detected to have changed within this period from the last build trigger, the event will be discarded.

  10. final val defaultAntiEntropyPollPeriod: FiniteDuration

    The duration for which we will poll for new file events when we are buffering events after an initial event has been detected to avoid spurious rebuilds.

    The duration for which we will poll for new file events when we are buffering events after an initial event has been detected to avoid spurious rebuilds.

    If this value is ever updated, please update the comment in Continuous.getFileEvents.

  11. final val defaultAntiEntropyRetentionPeriod: FiniteDuration

    The duration in wall clock time for which a FileEventMonitor will retain anti-entropy events for files.

    The duration in wall clock time for which a FileEventMonitor will retain anti-entropy events for files. This is an implementation detail of the FileEventMonitor. It should hopefully not need to be set by the users. It is needed because when a task takes a long time to run, it is possible that events will be detected for the file that triggered the build that occur within the anti-entropy period. We still allow it to be configured to limit the memory usage of the FileEventMonitor (but this is somewhat unlikely to be a problem).

  12. val defaultBeforeCommand: () ⇒ Unit

    Default no-op callback.

  13. final val defaultDeletionQuarantinePeriod: FiniteDuration

    The duration for which we delay triggering when a file is deleted.

    The duration for which we delay triggering when a file is deleted. This is needed because many programs implement save as a file move of a temporary file onto the target file. Depending on how the move is implemented, this may be detected as a deletion immediately followed by a creation. If we trigger immediately on delete, we may, for example, try to compile before all of the source files are actually available. The longer this value is set, the less likely we are to spuriously trigger a build before all files are available, but the longer it will take to trigger a build when the file is actually deleted and not renamed.

  14. final val defaultInputOptions: Seq[InputOption]
  15. def defaultInputOptionsMessage(options: Seq[InputOption]): String
  16. final def defaultInputParser(options: Seq[InputOption]): Parser[Action]

    Converts user input to an Action with the following rules: 1) 'x' or 'X' will exit sbt 2) 'r' or 'R' will trigger a build 3) new line characters cancel the watch and return to the shell

  17. final val defaultOnTriggerMessage: (Int, Path, Seq[String]) ⇒ Option[String]

    A constant function that always returns None.

    A constant function that always returns None. When Keys.watchTriggeredMessage := Watched.defaultOnTriggerMessage, then nothing is logged when a build is triggered.

  18. final val defaultPollInterval: FiniteDuration

    The minimum delay between file system polling when a PollingWatchService is used.

  19. val defaultStartWatch: (Int, ProjectRef, Seq[String]) ⇒ Option[String]

    A function that prints out the current iteration count and gives instructions for exiting or triggering the build.

  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final val noTriggerMessage: (Int, Path, Seq[String]) ⇒ Option[String]
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final val trigger: (Int, Event) ⇒ Action

    A constant function that returns Trigger.

  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  36. object Action

    Provides a default Ordering for actions.

    Provides a default Ordering for actions. Lower values correspond to higher priority actions. CancelWatch is higher priority than ContinueWatch.

  37. object CancelWatch extends CancelWatch with Product with Serializable

    Action that indicates that the watch should stop.

  38. object ContinueWatch

    Provides a default Ordering for classes extending ContinueWatch.

    Provides a default Ordering for classes extending ContinueWatch. Trigger is higher priority than Ignore.

  39. object Creation
  40. object Deletion
  41. object HandleError
  42. object HandleUnexpectedError
  43. object Ignore extends Ignore with Product with Serializable

    Action that indicates that the watch should continue as though nothing happened.

    Action that indicates that the watch should continue as though nothing happened. This may be because, for example, no user input was yet available.

  44. object InputOption
  45. object Prompt extends CancelWatch with Product with Serializable
  46. object Reload extends CancelWatch with Product with Serializable

    Action that indicates that the watch should pause while the build is reloaded.

    Action that indicates that the watch should pause while the build is reloaded. This is used to automatically reload the project when the build files (e.g. build.sbt) are changed.

  47. object Run
  48. object ShowOptions extends Ignore with Product with Serializable

    Action that indicates that the available options should be printed.

  49. object Trigger extends ContinueWatch with Product with Serializable

    Action that indicates that the watch process should re-run the command.

  50. object Update

Deprecated Value Members

  1. def apply(task: () ⇒ Unit, onStart: () ⇒ Action, nextAction: () ⇒ Action): Action
    Annotations
    @deprecated
    Deprecated

    (Since version 1.4.0) Unused in sbt but left for binary compatibility. Use five argument version instead.

Inherited from AnyRef

Inherited from Any

Ungrouped