Packages

trait Process[F[_], O, E] extends ProcessLike[F] with ProcessConfiguration[F]

Describes a system process to be executed

This base trait is always extended with redirection and configuration capabilities represented by the traits ProcessConfiguration, RedirectableInput, RedirectableOutput and RedirectableError.

To create a process use the constructor in the companion object Process.apply.

The process specification not only encodes the process to be started but also how its input, output and error streams are redirected and executed. For this reason the effect type is also bound by the process, not just at execution time.

F

Effect type

O

Output type

E

Error output type

Linear Supertypes
ProcessConfiguration[F], ProcessLikeConfiguration[F], ProcessLike[F], AnyRef, Any
Known Subclasses
ProcessImpl, ProcessImplE, ProcessImplI, ProcessImplIE, ProcessImplIO, ProcessImplIOE, ProcessImplO, ProcessImplOE
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Process
  2. ProcessConfiguration
  3. ProcessLikeConfiguration
  4. ProcessLike
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Self <: Process[F, O, E]
    Definition Classes
    Process → ProcessConfiguration → ProcessLikeConfiguration

Abstract Value Members

  1. abstract val arguments: List[String]
  2. abstract val command: String
  3. implicit abstract val concurrent: Concurrent[F]
  4. abstract val environmentVariables: Map[String, String]
    Definition Classes
    Process → ProcessLikeConfiguration
  5. abstract val errorRedirection: OutputRedirection[F]
  6. abstract val inputRedirection: InputRedirection[F]
  7. abstract val outputRedirection: OutputRedirection[F]
  8. abstract val removedEnvironmentVariables: Set[String]
    Definition Classes
    Process → ProcessLikeConfiguration
  9. abstract val runErrorStream: (java.io.InputStream, Blocker, ContextShift[F]) => F[E]
  10. abstract val runOutputStream: (java.io.InputStream, Blocker, ContextShift[F]) => F[O]
  11. abstract def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration
  12. abstract val workingDirectory: Option[Path]
    Definition Classes
    Process → ProcessLikeConfiguration

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. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration → ProcessLikeConfiguration
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. 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
  13. 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
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def run(blocker: Blocker)(implicit runner: ProcessRunner[F]): F[ProcessResult[O, E]]

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

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

    blocker

    Execution context for blocking operations

    runner

    The process runner to be used

    returns

    the result of the finished process

  19. def start(blocker: Blocker)(implicit runner: ProcessRunner[F]): Resource[F, Fiber[F, ProcessResult[O, E]]]

    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).

    blocker

    Execution context for blocking operations

    runner

    The process runner to be used

    returns

    a managed fiber representing the running process

  20. def startProcess(blocker: Blocker)(implicit runner: ProcessRunner[F]): F[RunningProcess[F, O, E]]

    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.

    blocker

    Execution context for blocking operations

    runner

    The process runner to be used

    returns

    interface for handling the running process

  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. 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
  27. 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
  28. 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
  29. 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

Inherited from ProcessConfiguration[F]

Inherited from ProcessLikeConfiguration[F]

Inherited from ProcessLike[F]

Inherited from AnyRef

Inherited from Any

Ungrouped