Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package github
    Definition Classes
    io
  • package vigoo
    Definition Classes
    github
  • package prox

    Provides classes to work with system processes in a type safe way.

    Provides classes to work with system processes in a type safe way.

    Refer to the user guide for more information.

    A process to be executed is represented by the Process trait. Once it has finished running the results are in ProcessResult. We call a group of processes attached together a process group, represented by ProcessGroup, its result is described by ProcessGroupResult.

    Redirection of input, output and error is enabled by the RedirectableInput, RedirectableOutput and RedirectableError trait for single processes, and the RedirectableErrors trait for process groups.

    Processes and process groups are executed by a ProcessRunner, the default implementation is called JVMProcessRunner.

    Definition Classes
    vigoo
  • trait ProcessModule extends AnyRef
    Definition Classes
    prox
  • object Process
    Definition Classes
    ProcessModule
  • ProcessImpl
  • ProcessImplE
  • ProcessImplI
  • ProcessImplIE
  • ProcessImplIO
  • ProcessImplIOE
  • ProcessImplO
  • ProcessImplOE

case class ProcessImplIO[O](command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[O], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[Unit], inputRedirection: Prox.InputRedirection) extends Prox.Process[O, Unit] with Prox.RedirectableError[[β$8$]ProcessImplIOE[O, β$8$]] with Product with Serializable

Process with bound input and output streams

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessImplIO
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableError
  6. Process
  7. ProcessConfiguration
  8. ProcessLikeConfiguration
  9. ProcessLike
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessImplIO(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[O], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[Unit], inputRedirection: Prox.InputRedirection)

Type Members

  1. type Self = ProcessImplIO[O]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def !>(path: Path): ProcessImplIOE[O, Unit]

    Redirects the error output to a file natively

    Redirects the error output to a file natively

    An alias for errorToFile

    path

    Target file path

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  3. def !>(sink: Prox.ProxSink[Byte]): ProcessImplIOE[O, Unit]

    Redirects the error output to a sink.

    Redirects the error output to a sink.

    The process error output type will be Unit. An alias for errorToSink

    sink

    Target sink

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  4. def !>#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplIOE[O, O]

    Redirects the error output to a pipe and folds its output with a monoid instance.

    Redirects the error output to a pipe and folds its output with a monoid instance.

    The process error output type will be the same as the pipe's output type. An alias for errorToFoldMonoid

    O

    Output type of the pipe. Must have a monoid instance.

    pipe

    Target pipe

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  5. def !>>(path: Path): ProcessImplIOE[O, Unit]

    Redirects the error output to a file natively in append mode

    Redirects the error output to a file natively in append mode

    An alias for appendErrorToFile

    path

    Target file path

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  6. def !>?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIOE[O, Vector[O]]

    Redirects the error output to a pipe and collects its output to a vector

    Redirects the error output to a pipe and collects its output to a vector

    The process error output type will be a vector of the pipe's output type. An alias for errorToVector

    O

    Output type of the pipe

    pipe

    Target pipe

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  7. final def ##: Int
    Definition Classes
    AnyRef → Any
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def appendErrorToFile(path: Path): ProcessImplIOE[O, Unit]

    Redirects the error output to a file natively in append mode

    Redirects the error output to a file natively in append mode

    An alias for !>>

    path

    Target file path

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  10. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfigurationProcessLikeConfiguration
  11. val arguments: List[String]
    Definition Classes
    ProcessImplIOProcess
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  14. val command: String
    Definition Classes
    ProcessImplIOProcess
  15. def connectError[R <: Prox.OutputRedirection, RE](target: R)(implicit outputRedirectionType: Aux[R, RE]): ProcessImplIOE[O, RE]

    The low level operation to attach an error output to a process

    The low level operation to attach an error output to a process

    Use one of the other methods of this trait for convenience. This is the place where the output type gets calculated with a helper type class called OutputRedirectionType which implements the type level computation for figuring out E.

    R

    Error output redirection type

    target

    Redirection target

    outputRedirectionType

    Helper for dependent error output type

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    ProcessImplIORedirectableError
  16. def drainError[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIOE[O, Unit]

    Redirects the error output to a pipe and drains it regardless of its output type.

    Redirects the error output to a pipe and drains it regardless of its output type.

    The process error output type will be Unit.

    O

    Output type of the pipe

    pipe

    Target pipe

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  17. val environmentVariables: Map[String, String]
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplIOProcess
  20. def errorToFile(path: Path): ProcessImplIOE[O, Unit]

    Redirects the error output to a file natively

    Redirects the error output to a file natively

    An alias for !>

    path

    Target file path

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  21. def errorToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplIOE[O, O]

    Redirects the error output to a pipe and folds its output with a monoid instance.

    Redirects the error output to a pipe and folds its output with a monoid instance.

    The process error output type will be the same as the pipe's output type. An alias for !>#

    O

    Output type of the pipe. Must have a monoid instance.

    pipe

    Target pipe

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  22. def errorToSink(sink: Prox.ProxSink[Byte]): ProcessImplIOE[O, Unit]

    Redirects the error output to a sink.

    Redirects the error output to a sink.

    The process error output type will be Unit. An alias for !>

    sink

    Target sink

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  23. def errorToVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIOE[O, Vector[O]]

    Redirects the error output to a pipe and collects its output to a vector

    Redirects the error output to a pipe and collects its output to a vector

    The process error output type will be a vector of the pipe's output type. An alias for !>?

    O

    Output type of the pipe

    pipe

    Target pipe

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  24. def foldError[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessImplIOE[O, R]

    Redirects the error output to a pipe and folds it with a custom function.

    Redirects the error output to a pipe and folds it with a custom function.

    The process error output type will be R.

    O

    Output type of the pipe

    R

    Result type of the fold

    pipe

    Target pipe

    init

    The initial value for the fold

    fn

    The fold function

    returns

    Returns a new process with its error output redirected and its error redirection capability removed.

    Definition Classes
    RedirectableError
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def in(workingDirectory: Path): Self

    Changes the working directory of the process

    Changes the working directory of the process

    workingDirectory

    the working directory

    returns

    a new process with the working directory set

    Definition Classes
    ProcessLikeConfiguration
  27. def inInheritedWorkingDirectory(): Self

    Use the inherited working directory of the process instead of an explicit one

    Use the inherited working directory of the process instead of an explicit one

    returns

    a new process with the working directory cleared

    Definition Classes
    ProcessLikeConfiguration
  28. val inputRedirection: Prox.InputRedirection
    Definition Classes
    ProcessImplIOProcess
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplIOProcess
  34. def productElementNames: Iterator[String]
    Definition Classes
    Product
  35. val removedEnvironmentVariables: Set[String]
  36. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessResult[O, Unit]]

    Starts the process asynchronously and blocks the execution until it is finished

    Starts the process asynchronously and blocks the execution until it is finished

    runner

    The process runner to be used

    returns

    the result of the finished process

    Definition Classes
    Process
  37. val runErrorStream: (InputStream) => Prox.ProxIO[Unit]
    Definition Classes
    ProcessImplIOProcess
  38. val runOutputStream: (InputStream) => Prox.ProxIO[O]
    Definition Classes
    ProcessImplIOProcess
  39. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImplIO[O]
    Attributes
    protected
    Definition Classes
    ProcessImplIOProcessConfiguration
  40. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessResult[O, Unit]]]

    Starts the process asynchronously and returns a closeable fiber representing it

    Starts the process asynchronously and returns a closeable fiber representing it

    Joining the fiber waits for the process to be terminated. Canceling the fiber terminates the process normally (with SIGTERM).

    runner

    The process runner to be used

    returns

    a managed fiber representing the running process

    Definition Classes
    Process
  41. def startProcess[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcess[O, Unit, Info]]

    Starts the process asynchronously and returns the RunningProcess interface for it

    Starts the process asynchronously and returns the RunningProcess interface for it

    This is the most advanced way to start processes. See start and run as alternatives.

    Info

    The runner-specific process info type

    runner

    The process runner to be used

    returns

    interface for handling the running process

    Definition Classes
    Process
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. def with(nameValuePair: (String, String)): Self

    Adds an environment variable to the process

    Adds an environment variable to the process

    nameValuePair

    A pair of name and value

    returns

    a new process with the working directory set

    Definition Classes
    ProcessLikeConfiguration
  47. def withArguments(newArguments: List[String]): Self

    Replaces the arguments

    Replaces the arguments

    newArguments

    new list of arguments

    returns

    returns a new process specification

    Definition Classes
    ProcessConfiguration
  48. def withCommand(newCommand: String): Self

    Replaces the command

    Replaces the command

    newCommand

    new value for the command to be executed

    returns

    returns a new process specification

    Definition Classes
    ProcessConfiguration
  49. def without(name: String): Self

    Removes an environment variable from the process

    Removes an environment variable from the process

    Usable to remove variables inherited from the parent process.

    name

    Name of the environment variable

    returns

    a new process with the working directory set

    Definition Classes
    ProcessLikeConfiguration
  50. val workingDirectory: Option[Path]

Deprecated Value Members

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

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableError[[β$8$]ProcessImplIOE[O, β$8$]]

Inherited from Prox.Process[O, Unit]

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped