prox-core
API
Generated with
prox-core/io.github.vigoo.prox/ProcessModule/Process/ProcessImplI

ProcessImplI

io.github.vigoo.prox.ProcessModule.Process.ProcessImplI
case class ProcessImplI(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: OutputRedirection, runOutputStream: InputStream => ProxIO[Unit], errorRedirection: OutputRedirection, runErrorStream: InputStream => ProxIO[Unit], inputRedirection: InputRedirection) extends Process[Unit, Unit], RedirectableOutput[ProcessImplIO], RedirectableError[ProcessImplIE]

Process with bound input streams

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Process[Unit, Unit]
trait ProcessLike
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

override type Self = ProcessImplI

Value members

Concrete methods

override def connectError[R <: OutputRedirection, RE](target: R)(implicit outputRedirectionType: Aux[R, RE]): ProcessImplIE[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.

Type parameters

E

Error output type

R

Error output redirection type

Value parameters

outputRedirectionType

Helper for dependent error output type

target

Redirection target

Attributes

Returns

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

Definition Classes
def connectOutput[R <: OutputRedirection, RO](target: R)(implicit outputRedirectionType: Aux[R, RO]): ProcessImplIO[RO]

The low level operation to attach an output to a process

The low level operation to attach an 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 O.

Type parameters

O

Output type

R

Output redirection type

Value parameters

outputRedirectionType

Helper for dependent output type

target

Redirection target

Attributes

Returns

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

Inherited methods

def !>(path: Path): P[Unit]

Redirects the error output to a file natively

Redirects the error output to a file natively

An alias for errorToFile

Value parameters

path

Target file path

Attributes

Returns

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

Inherited from:
RedirectableError
def !>(sink: ProxSink[Byte]): P[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

Value parameters

sink

Target sink

Attributes

Returns

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

Inherited from:
RedirectableError
def !>#[O : ProxMonoid](pipe: ProxPipe[Byte, O]): P[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

Type parameters

O

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

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableError
def !>>(path: Path): P[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

Value parameters

path

Target file path

Attributes

Returns

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

Inherited from:
RedirectableError
def !>?[O](pipe: ProxPipe[Byte, O]): P[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

Type parameters

O

Output type of the pipe

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableError
def >(path: Path): P[Unit]

Redirects the output to a file natively

Redirects the output to a file natively

An alias for toFile

Value parameters

path

Target file path

Attributes

Returns

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

Inherited from:
RedirectableOutput
def >(sink: ProxSink[Byte]): P[Unit]

Redirects the output to a sink.

Redirects the output to a sink.

The process output type will be Unit. An alias for toSink

Value parameters

sink

Target sink

Attributes

Returns

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

Inherited from:
RedirectableOutput
def >#[O : ProxMonoid](pipe: ProxPipe[Byte, O]): P[O]

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

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

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

Type parameters

O

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

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableOutput
def >>(path: Path): P[Unit]

Redirects the output to a file natively in append mode

Redirects the output to a file natively in append mode

An alias for appendToFile

Value parameters

path

Target file path

Attributes

Returns

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

Inherited from:
RedirectableOutput
def >?[O](pipe: ProxPipe[Byte, O]): P[Vector[O]]

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

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

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

Type parameters

O

Output type of the pipe

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableOutput
def `with`(nameValuePair: (String, String)): Self

Adds an environment variable to the process

Adds an environment variable to the process

Value parameters

nameValuePair

A pair of name and value

Attributes

Returns

a new process with the working directory set

Inherited from:
ProcessLikeConfiguration
def appendErrorToFile(path: Path): P[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 !&gt;&gt;

Value parameters

path

Target file path

Attributes

Returns

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

Inherited from:
RedirectableError
def appendToFile(path: Path): P[Unit]

Redirects the output to a file natively in append mode

Redirects the output to a file natively in append mode

An alias for &gt;&gt;

Value parameters

path

Target file path

Attributes

Returns

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

Inherited from:
RedirectableOutput
override protected def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self

Attributes

Definition Classes
Inherited from:
ProcessConfiguration
def drainError[O](pipe: ProxPipe[Byte, O]): P[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.

Type parameters

O

Output type of the pipe

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableError
def drainOutput[O](pipe: ProxPipe[Byte, O]): P[Unit]

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

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

The process output type will be Unit.

Type parameters

O

Output type of the pipe

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableOutput
def errorToFile(path: Path): P[Unit]

Redirects the error output to a file natively

Redirects the error output to a file natively

An alias for !&gt;

Value parameters

path

Target file path

Attributes

Returns

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

Inherited from:
RedirectableError
def errorToFoldMonoid[O : ProxMonoid](pipe: ProxPipe[Byte, O]): P[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 !&gt;#

Type parameters

O

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

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableError
def errorToSink(sink: ProxSink[Byte]): P[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 !&gt;

Value parameters

sink

Target sink

Attributes

Returns

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

Inherited from:
RedirectableError
def errorToVector[O](pipe: ProxPipe[Byte, O]): P[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 !&gt;?

Type parameters

O

Output type of the pipe

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableError
def foldError[O, R](pipe: ProxPipe[Byte, O], init: R, fn: (R, O) => R): P[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.

Type parameters

O

Output type of the pipe

R

Result type of the fold

Value parameters

fn

The fold function

init

The initial value for the fold

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableError
def foldOutput[O, R](pipe: ProxPipe[Byte, O], init: R, fn: (R, O) => R): P[R]

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

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

The process output type will be R.

Type parameters

O

Output type of the pipe

R

Result type of the fold

Value parameters

fn

The fold function

init

The initial value for the fold

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableOutput
def in(workingDirectory: Path): Self

Changes the working directory of the process

Changes the working directory of the process

Value parameters

workingDirectory

the working directory

Attributes

Returns

a new process with the working directory set

Inherited from:
ProcessLikeConfiguration
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

Attributes

Returns

a new process with the working directory cleared

Inherited from:
ProcessLikeConfiguration
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def run[Info]()(implicit runner: ProcessRunner[Info]): ProxIO[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

Value parameters

runner

The process runner to be used

Attributes

Returns

the result of the finished process

Inherited from:
Process
def start[Info]()(implicit runner: ProcessRunner[Info]): ProxResource[ProxFiber[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).

Value parameters

runner

The process runner to be used

Attributes

Returns

a managed fiber representing the running process

Inherited from:
Process
def startProcess[Info]()(implicit runner: ProcessRunner[Info]): ProxIO[RunningProcess[O, E, 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.

Type parameters

Info

The runner-specific process info type

Value parameters

runner

The process runner to be used

Attributes

Returns

interface for handling the running process

Inherited from:
Process
def toFile(path: Path): P[Unit]

Redirects the output to a file natively

Redirects the output to a file natively

An alias for &gt;

Value parameters

path

Target file path

Attributes

Returns

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

Inherited from:
RedirectableOutput
def toFoldMonoid[O : ProxMonoid](pipe: ProxPipe[Byte, O]): P[O]

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

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

The process output type will be the same as the pipe's output type. An alias for &gt;#

Type parameters

O

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

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableOutput
def toSink(sink: ProxSink[Byte]): P[Unit]

Redirects the output to a sink.

Redirects the output to a sink.

The process output type will be Unit. An alias for &gt;

Value parameters

sink

Target sink

Attributes

Returns

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

Inherited from:
RedirectableOutput
def toVector[O](pipe: ProxPipe[Byte, O]): P[Vector[O]]

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

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

The process output type will be a vector of the pipe's output type. An alias for &gt;?

Type parameters

O

Output type of the pipe

Value parameters

pipe

Target pipe

Attributes

Returns

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

Inherited from:
RedirectableOutput
def withArguments(newArguments: List[String]): Self

Replaces the arguments

Replaces the arguments

Value parameters

newArguments

new list of arguments

Attributes

Returns

returns a new process specification

Inherited from:
ProcessConfiguration
def withCommand(newCommand: String): Self

Replaces the command

Replaces the command

Value parameters

newCommand

new value for the command to be executed

Attributes

Returns

returns a new process specification

Inherited from:
ProcessConfiguration
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.

Value parameters

name

Name of the environment variable

Attributes

Returns

a new process with the working directory set

Inherited from:
ProcessLikeConfiguration
Generated with