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.

Overview

A system process to be started is represented by the Process case class, taking a command and optionally a list of arguments and a working directory:

import io.github.vigoo.prox._
import io.github.vigoo.prox.syntax._

val process = Process("echo", List("Hello world"))

To start the process, we can use the syntax.ProcessOps.start extension method, defined in syntax.ProcessOps, which creates a cats IO operation returning a RunningProcess instance.

Use the returned value to wait for the process to exit or to send a termination signal to it:

val program = Blocker[IO].use { blocker =>
  for {
    echo <- Process("echo", List("Hello world")).start(blocker)
    result <- echo.waitForExit()
  } yield result.exitCode
}

val exitCode = program.unsafeRunSync()

Redirection

The syntax.ProcessNodeInputRedirect, syntax.ProcessNodeOutputRedirect and syntax.ProcessNodeErrorRedirect classes define extension methods for processes to redirect their inpout, output and error streams. The target of redirection can be anything that has the matching type class defined for: CanBeProcessInputSource, CanBeProcessOutputTarget and CanBeProcessErrorTarget.

The three extension methods are syntax.ProcessNodeInputRedirect.<, syntax.ProcessNodeOutputRedirect.> and syntax.ProcessNodeErrorRedirect.redirectErrorTo

The type system guarantees that each redirection can only happen once for a process.

Streams

The library provides type classes to redirect to/from fs2 streams: InputStreamingSource for feeding a stream as a process' input, and OutputStreamingTarget and ErrorStreamingTarget to feed a process' output and error to fs2 pipes.

Three special wrapper types can be used to modify how the streams are executed when the IO operation is composed:

Drain to run the stream with fs2.Stream.CompileOps.drain, having a result of Unit
ToVector to run the stream with fs2.Stream.CompileOps.toVector, having a result of Vector
Fold to run the stream with fs2.Stream.CompileOps.fold, having a custom fold result

If none of the above wrappers is used, the default is to use fs2.Stream.CompileOps.drain for fs2.Sink, fs2.Stream.CompileOps.foldMonoid if the pipe's output is a cats.Monoid and fs2.Stream.CompileOps.toVector otherwise.

Piping

The syntax.ProcessNodeOutputRedirect class defined two extension methods for piping one process to another: syntax.ProcessNodeOutputRedirect.| for direct piping and syntax.ProcessNodeOutputRedirect.via for piping through a custom fs2 fs2.Pipe.

The result of the piping operators is a PipedProcess, which can be used exactly as a simple process, but its syntax.ProcessOps.start method returns a tuple of RunningProcess instances.

Definition Classes: vigoo

package path

Small helper package to work with Java NIO paths

Definition Classes: prox

CanBeProcessErrorTarget

CanBeProcessInputSource

CanBeProcessOutputTarget

FlushControlledInputStreamingSource

Fold

InputStreamingSource

LowPriorityCanBeProcessErrorTarget

LowPriorityCanBeProcessOutputTarget

LowerPriorityCanBeProcessErrorTarget

LowerPriorityCanBeProcessOutputTarget

NotRedirected

OutputStreamingTarget

OutputStreamingTargetBase

Start

Companion trait Start

object Start

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Start
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

type Aux[F[_], PN, RP, RPL <: HList] = Start[F, PN] { ... /* 2 definitions in type refinement */ }

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def apply[F[_], PN <: ProcessNode[_, _, _, _, _], RP, RPL <: HList](implicit start: Aux[F, PN, RP, RPL]): Aux[F, PN, RP, RPL]
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
implicit def startPipedProcess[F[_], Out, Err, PN1 <: ProcessNode[_, _, _, _, _], PN2 <: ProcessNode[_, _, _, _, _], IRS <: RedirectionState, ORS <: RedirectionState, ERS <: RedirectionState, RP1, RPL1 <: HList, RP1Last, RP2, RPL2 <: HList, RP2Head, RP2Tail <: HList, RPT, RPL <: HList](implicit start1: Aux[F, PN1, RP1, RPL1], start2: Aux[F, PN2, RP2, RPL2], last1: shapeless.ops.hlist.Last.Aux[RPL1, RP1Last], rp1LastType: <:<[RP1Last, RunningProcess[F, Byte, _, _]], hcons2: shapeless.ops.hlist.IsHCons.Aux[RPL2, RP2Head, RP2Tail], prepend: shapeless.ops.hlist.Prepend.Aux[RPL1, RPL2, RPL], tupler: shapeless.ops.hlist.Tupler.Aux[RPL, RPT]): Aux[F, PipedProcess[F, Out, Err, Byte, PN1, PN2, IRS, ORS, ERS], RPT, RPL]
implicit def startProcess[F[_], Out, Err, OutResult, ErrResult, IRS <: RedirectionState, ORS <: RedirectionState, ERS <: RedirectionState](implicit arg0: Monoid[OutResult]): Aux[F, Process[F, Out, Err, OutResult, ErrResult, IRS, ORS, ERS], RunningProcess[F, Out, OutResult, ErrResult], ::[RunningProcess[F, Out, OutResult, ErrResult], HNil]]
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

Overview

Redirection

Streams

Piping

Start

Companion trait Start

object Start

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Overview

Redirection

Streams

Piping

Start

Companion trait Start

object Start

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Start