diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs deleted file mode 100644 index add2810b..00000000 --- a/.git-blame-ignore-revs +++ /dev/null @@ -1,5 +0,0 @@ -# Scala Steward: Reformat with scalafmt 3.8.1 -9dd9b24328ef9e0200929265b623295bf8f7f6a3 - -# Scala Steward: Reformat with scalafmt 3.8.6 -12ea712573e8e3e8b26a9c3bb69ad0e921b8cfbb diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml deleted file mode 100644 index dbc2d53a..00000000 --- a/.github/workflows/ci.yaml +++ /dev/null @@ -1,26 +0,0 @@ -name: CI -on: - push: - pull_request: -jobs: - build-test: - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - scala: ['2.12.18', '2.13.12', '3.3.1'] - steps: - - name: Checkout - uses: actions/checkout@v2 - - name: Setup Scala - uses: olafurpg/setup-scala@v10 - with: - java-version: "adopt@1.11" - - name: Coursier cache - uses: coursier/cache-action@v5 - - name: Build and test - if: ${{ matrix.scala == '3.1.0' }} - run: sbt ++${{ matrix.scala }} clean test - - name: Build and test - if: ${{ matrix.scala != '3.1.0' }} - run: sbt ++${{ matrix.scala }} clean coverage test coverageReport && bash <(curl -s https://codecov.io/bash) diff --git a/.github/workflows/doc.yaml b/.github/workflows/doc.yaml deleted file mode 100644 index 0f285607..00000000 --- a/.github/workflows/doc.yaml +++ /dev/null @@ -1,38 +0,0 @@ -name: Website - -on: - release: - types: - - published - workflow_dispatch: - -jobs: - publish: - runs-on: ubuntu-latest - if: github.event_name != 'pull_request' - steps: - - uses: actions/checkout@v2 - with: - fetch-depth: 0 - - uses: olafurpg/setup-scala@v10 - with: - java-version: "adopt@1.11" - - uses: olafurpg/setup-gpg@v3 - - name: Setup GIT user - uses: fregante/setup-git-user@v1 - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: 2.6.6 - bundler-cache: true - - name: Install Jekyll - run: | - gem install sass - gem install activesupport -v 6.1.4.4 - gem install jekyll -v 4.0.0 - gem install nokogiri -v 1.13.10 - gem install jemoji -v 0.11.1 - gem install jekyll-sitemap -v 1.4.0 - - run: sbt docs/publishMicrosite - env: - GITHUB_TOKEN: ${{ secrets.ADMIN_GITHUB_TOKEN }} diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml deleted file mode 100644 index 00b79177..00000000 --- a/.github/workflows/release.yaml +++ /dev/null @@ -1,26 +0,0 @@ -name: Release -on: - push: - branches: ['master'] - release: - types: - - published -jobs: - publish: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v2 - with: - fetch-depth: 0 - - name: Setup Scala - uses: olafurpg/setup-scala@v10 - with: - java-version: "adopt@1.11" - - uses: olafurpg/setup-gpg@v3 - - run: sbt ci-release - env: - PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }} - PGP_SECRET: ${{ secrets.PGP_SECRET }} - SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} - SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }} \ No newline at end of file diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 61935f2c..00000000 --- a/.gitignore +++ /dev/null @@ -1,12 +0,0 @@ -dist/* -target/ -lib_managed/ -src_managed/ -project/boot/ -project/plugins/project/ -.history -.cache -.lib/ -.idea -examples/externalpyproc/virtualenv -.bloop/ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/.scalafmt.conf b/.scalafmt.conf deleted file mode 100644 index 463060b8..00000000 --- a/.scalafmt.conf +++ /dev/null @@ -1,2 +0,0 @@ -version = 3.8.6 -runner.dialect = "scala213source3" \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9e..00000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/README.md b/README.md deleted file mode 100644 index 977e1b43..00000000 --- a/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# [prox](https://vigoo.github.io/prox) -![CI](https://github.com/vigoo/prox/workflows/CI/badge.svg) -[![codecov](https://codecov.io/gh/vigoo/prox/branch/master/graph/badge.svg)](https://codecov.io/gh/vigoo/prox) -[![Apache 2 License License](http://img.shields.io/badge/license-APACHE2-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) -[![Latest version](https://index.scala-lang.org/vigoo/prox/prox-core/latest.svg)](https://index.scala-lang.org/vigoo/prox/prox-core) -![Maven central](https://img.shields.io/maven-central/v/io.github.vigoo/prox-core_2.13.svg?style=flat-square) - -**prox** is a small library that helps you starting system processes and redirecting their input/output/error streams, -either to files, [fs2](https://github.com/functional-streams-for-scala/fs2) streams or each other. - -> :warning: **Version 0.5 is a complete redesign of the library** - -See the [project's site](https://vigoo.github.io/prox) for documentation and examples. - - ----- - -YourKit supports open source projects with innovative and intelligent tools -for monitoring and profiling Java and .NET applications. -YourKit is the creator of YourKit Java Profiler, -YourKit .NET Profiler, -and YourKit YouMonitor. diff --git a/api/index.html b/api/index.html new file mode 100644 index 00000000..0ed6d313 --- /dev/null +++ b/api/index.html @@ -0,0 +1,2 @@ +

Packages

p

root package

package root

Package Members

  1. package io
  2. package zio

Ungrouped

diff --git a/api/index.js b/api/index.js new file mode 100644 index 00000000..3f518d30 --- /dev/null +++ b/api/index.js @@ -0,0 +1 @@ +Index.PACKAGES = {"io.github.vigoo.prox.path" : [{"name" : "io.github.vigoo.prox.path.PathOps", "shortDescription" : "Extension methods for java.nio.file.Path", "members_class" : [{"label" : "\/", "tail" : "(child: String): Path", "member" : "io.github.vigoo.prox.path.PathOps.\/", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#\/(child:String):java.nio.file.Path", "kind" : "def"}, {"member" : "io.github.vigoo.prox.path.PathOps#", "error" : "unsupported entity"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "class" : "io\/github\/vigoo\/prox\/path\/package$$PathOps.html", "kind" : "class"}], "io.github.vigoo.prox.java9" : [{"name" : "io.github.vigoo.prox.java9.Java9Module", "trait" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html", "kind" : "trait", "members_trait" : [{"label" : "JVM9ProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.java9.Java9Module.JVM9ProcessRunner", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#JVM9ProcessRunnerextendsJava9Module.this.JVMProcessRunnerBase[Java9Module.this.JVM9ProcessInfo]", "kind" : "class"}, {"label" : "JVM9ProcessInfo", "tail" : "", "member" : "io.github.vigoo.prox.java9.Java9Module.JVM9ProcessInfo", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#JVM9ProcessInfoextendsJava9Module.this.JVMProcessInfowithProductwithSerializable", "kind" : "case class"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/java9\/Java9Module.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "shortDescription" : ""}], "zio" : [], "io.github.vigoo.prox" : [{"name" : "io.github.vigoo.prox.CommonModule", "trait" : "io\/github\/vigoo\/prox\/CommonModule.html", "kind" : "trait", "members_trait" : [{"label" : "ProcessLikeConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.CommonModule.ProcessLikeConfiguration", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#ProcessLikeConfigurationextendsAnyRef", "kind" : "trait"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/CommonModule.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.FailedToDestroy", "shortDescription" : "", "members_case class" : [{"label" : "toThrowable", "tail" : "(): Throwable", "member" : "io.github.vigoo.prox.FailedToDestroy.toThrowable", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#toThrowable:Throwable", "kind" : "def"}, {"member" : "io.github.vigoo.prox.FailedToDestroy#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToDestroy.reason", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToDestroy.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToDestroy.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToDestroyException", "shortDescription" : "", "members_case class" : [{"member" : "io.github.vigoo.prox.FailedToDestroyException#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToDestroyException.reason", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "getSuppressed", "tail" : "(): Array[Throwable]", "member" : "java.lang.Throwable.getSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#getSuppressed():Array[Throwable]", "kind" : "final def"}, {"label" : "addSuppressed", "tail" : "(arg0: Throwable): Unit", "member" : "java.lang.Throwable.addSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#addSuppressed(x$1:Throwable):Unit", "kind" : "final def"}, {"label" : "setStackTrace", "tail" : "(arg0: Array[StackTraceElement]): Unit", "member" : "java.lang.Throwable.setStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#setStackTrace(x$1:Array[StackTraceElement]):Unit", "kind" : "def"}, {"label" : "getStackTrace", "tail" : "(): Array[StackTraceElement]", "member" : "java.lang.Throwable.getStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#getStackTrace():Array[StackTraceElement]", "kind" : "def"}, {"label" : "fillInStackTrace", "tail" : "(): Throwable", "member" : "java.lang.Throwable.fillInStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#fillInStackTrace():Throwable", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintWriter): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#printStackTrace(x$1:java.io.PrintWriter):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintStream): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#printStackTrace(x$1:java.io.PrintStream):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#printStackTrace():Unit", "kind" : "def"}, {"label" : "toString", "tail" : "(): String", "member" : "java.lang.Throwable.toString", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#toString():String", "kind" : "def"}, {"label" : "initCause", "tail" : "(arg0: Throwable): Throwable", "member" : "java.lang.Throwable.initCause", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#initCause(x$1:Throwable):Throwable", "kind" : "def"}, {"label" : "getCause", "tail" : "(): Throwable", "member" : "java.lang.Throwable.getCause", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#getCause():Throwable", "kind" : "def"}, {"label" : "getLocalizedMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getLocalizedMessage", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#getLocalizedMessage():String", "kind" : "def"}, {"label" : "getMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getMessage", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#getMessage():String", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToDestroyException.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToQueryState", "shortDescription" : "", "members_case class" : [{"label" : "toThrowable", "tail" : "(): Throwable", "member" : "io.github.vigoo.prox.FailedToQueryState.toThrowable", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#toThrowable:Throwable", "kind" : "def"}, {"member" : "io.github.vigoo.prox.FailedToQueryState#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToQueryState.reason", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToQueryState.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToQueryState.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToQueryStateException", "shortDescription" : "", "members_case class" : [{"member" : "io.github.vigoo.prox.FailedToQueryStateException#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToQueryStateException.reason", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "getSuppressed", "tail" : "(): Array[Throwable]", "member" : "java.lang.Throwable.getSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#getSuppressed():Array[Throwable]", "kind" : "final def"}, {"label" : "addSuppressed", "tail" : "(arg0: Throwable): Unit", "member" : "java.lang.Throwable.addSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#addSuppressed(x$1:Throwable):Unit", "kind" : "final def"}, {"label" : "setStackTrace", "tail" : "(arg0: Array[StackTraceElement]): Unit", "member" : "java.lang.Throwable.setStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#setStackTrace(x$1:Array[StackTraceElement]):Unit", "kind" : "def"}, {"label" : "getStackTrace", "tail" : "(): Array[StackTraceElement]", "member" : "java.lang.Throwable.getStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#getStackTrace():Array[StackTraceElement]", "kind" : "def"}, {"label" : "fillInStackTrace", "tail" : "(): Throwable", "member" : "java.lang.Throwable.fillInStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#fillInStackTrace():Throwable", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintWriter): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#printStackTrace(x$1:java.io.PrintWriter):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintStream): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#printStackTrace(x$1:java.io.PrintStream):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#printStackTrace():Unit", "kind" : "def"}, {"label" : "toString", "tail" : "(): String", "member" : "java.lang.Throwable.toString", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#toString():String", "kind" : "def"}, {"label" : "initCause", "tail" : "(arg0: Throwable): Throwable", "member" : "java.lang.Throwable.initCause", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#initCause(x$1:Throwable):Throwable", "kind" : "def"}, {"label" : "getCause", "tail" : "(): Throwable", "member" : "java.lang.Throwable.getCause", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#getCause():Throwable", "kind" : "def"}, {"label" : "getLocalizedMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getLocalizedMessage", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#getLocalizedMessage():String", "kind" : "def"}, {"label" : "getMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getMessage", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#getMessage():String", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToQueryStateException.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToReadProcessOutput", "shortDescription" : "", "members_case class" : [{"label" : "toThrowable", "tail" : "(): Throwable", "member" : "io.github.vigoo.prox.FailedToReadProcessOutput.toThrowable", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#toThrowable:Throwable", "kind" : "def"}, {"member" : "io.github.vigoo.prox.FailedToReadProcessOutput#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToReadProcessOutput.reason", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutput.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToReadProcessOutputException", "shortDescription" : "", "members_case class" : [{"member" : "io.github.vigoo.prox.FailedToReadProcessOutputException#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToReadProcessOutputException.reason", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "getSuppressed", "tail" : "(): Array[Throwable]", "member" : "java.lang.Throwable.getSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#getSuppressed():Array[Throwable]", "kind" : "final def"}, {"label" : "addSuppressed", "tail" : "(arg0: Throwable): Unit", "member" : "java.lang.Throwable.addSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#addSuppressed(x$1:Throwable):Unit", "kind" : "final def"}, {"label" : "setStackTrace", "tail" : "(arg0: Array[StackTraceElement]): Unit", "member" : "java.lang.Throwable.setStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#setStackTrace(x$1:Array[StackTraceElement]):Unit", "kind" : "def"}, {"label" : "getStackTrace", "tail" : "(): Array[StackTraceElement]", "member" : "java.lang.Throwable.getStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#getStackTrace():Array[StackTraceElement]", "kind" : "def"}, {"label" : "fillInStackTrace", "tail" : "(): Throwable", "member" : "java.lang.Throwable.fillInStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#fillInStackTrace():Throwable", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintWriter): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#printStackTrace(x$1:java.io.PrintWriter):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintStream): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#printStackTrace(x$1:java.io.PrintStream):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#printStackTrace():Unit", "kind" : "def"}, {"label" : "toString", "tail" : "(): String", "member" : "java.lang.Throwable.toString", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#toString():String", "kind" : "def"}, {"label" : "initCause", "tail" : "(arg0: Throwable): Throwable", "member" : "java.lang.Throwable.initCause", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#initCause(x$1:Throwable):Throwable", "kind" : "def"}, {"label" : "getCause", "tail" : "(): Throwable", "member" : "java.lang.Throwable.getCause", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#getCause():Throwable", "kind" : "def"}, {"label" : "getLocalizedMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getLocalizedMessage", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#getLocalizedMessage():String", "kind" : "def"}, {"label" : "getMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getMessage", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#getMessage():String", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToReadProcessOutputException.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToStartProcess", "shortDescription" : "", "members_case class" : [{"label" : "toThrowable", "tail" : "(): Throwable", "member" : "io.github.vigoo.prox.FailedToStartProcess.toThrowable", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#toThrowable:Throwable", "kind" : "def"}, {"member" : "io.github.vigoo.prox.FailedToStartProcess#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToStartProcess.reason", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToStartProcess.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToStartProcessException", "shortDescription" : "", "members_case class" : [{"member" : "io.github.vigoo.prox.FailedToStartProcessException#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToStartProcessException.reason", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "getSuppressed", "tail" : "(): Array[Throwable]", "member" : "java.lang.Throwable.getSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#getSuppressed():Array[Throwable]", "kind" : "final def"}, {"label" : "addSuppressed", "tail" : "(arg0: Throwable): Unit", "member" : "java.lang.Throwable.addSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#addSuppressed(x$1:Throwable):Unit", "kind" : "final def"}, {"label" : "setStackTrace", "tail" : "(arg0: Array[StackTraceElement]): Unit", "member" : "java.lang.Throwable.setStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#setStackTrace(x$1:Array[StackTraceElement]):Unit", "kind" : "def"}, {"label" : "getStackTrace", "tail" : "(): Array[StackTraceElement]", "member" : "java.lang.Throwable.getStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#getStackTrace():Array[StackTraceElement]", "kind" : "def"}, {"label" : "fillInStackTrace", "tail" : "(): Throwable", "member" : "java.lang.Throwable.fillInStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#fillInStackTrace():Throwable", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintWriter): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#printStackTrace(x$1:java.io.PrintWriter):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintStream): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#printStackTrace(x$1:java.io.PrintStream):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#printStackTrace():Unit", "kind" : "def"}, {"label" : "toString", "tail" : "(): String", "member" : "java.lang.Throwable.toString", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#toString():String", "kind" : "def"}, {"label" : "initCause", "tail" : "(arg0: Throwable): Throwable", "member" : "java.lang.Throwable.initCause", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#initCause(x$1:Throwable):Throwable", "kind" : "def"}, {"label" : "getCause", "tail" : "(): Throwable", "member" : "java.lang.Throwable.getCause", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#getCause():Throwable", "kind" : "def"}, {"label" : "getLocalizedMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getLocalizedMessage", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#getLocalizedMessage():String", "kind" : "def"}, {"label" : "getMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getMessage", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#getMessage():String", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToStartProcessException.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToWaitForExit", "shortDescription" : "", "members_case class" : [{"label" : "toThrowable", "tail" : "(): Throwable", "member" : "io.github.vigoo.prox.FailedToWaitForExit.toThrowable", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#toThrowable:Throwable", "kind" : "def"}, {"member" : "io.github.vigoo.prox.FailedToWaitForExit#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToWaitForExit.reason", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToWaitForExit.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToWaitForExitException", "shortDescription" : "", "members_case class" : [{"member" : "io.github.vigoo.prox.FailedToWaitForExitException#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToWaitForExitException.reason", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "getSuppressed", "tail" : "(): Array[Throwable]", "member" : "java.lang.Throwable.getSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#getSuppressed():Array[Throwable]", "kind" : "final def"}, {"label" : "addSuppressed", "tail" : "(arg0: Throwable): Unit", "member" : "java.lang.Throwable.addSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#addSuppressed(x$1:Throwable):Unit", "kind" : "final def"}, {"label" : "setStackTrace", "tail" : "(arg0: Array[StackTraceElement]): Unit", "member" : "java.lang.Throwable.setStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#setStackTrace(x$1:Array[StackTraceElement]):Unit", "kind" : "def"}, {"label" : "getStackTrace", "tail" : "(): Array[StackTraceElement]", "member" : "java.lang.Throwable.getStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#getStackTrace():Array[StackTraceElement]", "kind" : "def"}, {"label" : "fillInStackTrace", "tail" : "(): Throwable", "member" : "java.lang.Throwable.fillInStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#fillInStackTrace():Throwable", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintWriter): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#printStackTrace(x$1:java.io.PrintWriter):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintStream): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#printStackTrace(x$1:java.io.PrintStream):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#printStackTrace():Unit", "kind" : "def"}, {"label" : "toString", "tail" : "(): String", "member" : "java.lang.Throwable.toString", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#toString():String", "kind" : "def"}, {"label" : "initCause", "tail" : "(arg0: Throwable): Throwable", "member" : "java.lang.Throwable.initCause", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#initCause(x$1:Throwable):Throwable", "kind" : "def"}, {"label" : "getCause", "tail" : "(): Throwable", "member" : "java.lang.Throwable.getCause", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#getCause():Throwable", "kind" : "def"}, {"label" : "getLocalizedMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getLocalizedMessage", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#getLocalizedMessage():String", "kind" : "def"}, {"label" : "getMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getMessage", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#getMessage():String", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToWaitForExitException.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToWriteProcessInput", "shortDescription" : "", "members_case class" : [{"label" : "toThrowable", "tail" : "(): Throwable", "member" : "io.github.vigoo.prox.FailedToWriteProcessInput.toThrowable", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#toThrowable:Throwable", "kind" : "def"}, {"member" : "io.github.vigoo.prox.FailedToWriteProcessInput#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToWriteProcessInput.reason", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInput.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.FailedToWriteProcessInputException", "shortDescription" : "", "members_case class" : [{"member" : "io.github.vigoo.prox.FailedToWriteProcessInputException#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.FailedToWriteProcessInputException.reason", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "getSuppressed", "tail" : "(): Array[Throwable]", "member" : "java.lang.Throwable.getSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#getSuppressed():Array[Throwable]", "kind" : "final def"}, {"label" : "addSuppressed", "tail" : "(arg0: Throwable): Unit", "member" : "java.lang.Throwable.addSuppressed", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#addSuppressed(x$1:Throwable):Unit", "kind" : "final def"}, {"label" : "setStackTrace", "tail" : "(arg0: Array[StackTraceElement]): Unit", "member" : "java.lang.Throwable.setStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#setStackTrace(x$1:Array[StackTraceElement]):Unit", "kind" : "def"}, {"label" : "getStackTrace", "tail" : "(): Array[StackTraceElement]", "member" : "java.lang.Throwable.getStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#getStackTrace():Array[StackTraceElement]", "kind" : "def"}, {"label" : "fillInStackTrace", "tail" : "(): Throwable", "member" : "java.lang.Throwable.fillInStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#fillInStackTrace():Throwable", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintWriter): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#printStackTrace(x$1:java.io.PrintWriter):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintStream): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#printStackTrace(x$1:java.io.PrintStream):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#printStackTrace():Unit", "kind" : "def"}, {"label" : "toString", "tail" : "(): String", "member" : "java.lang.Throwable.toString", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#toString():String", "kind" : "def"}, {"label" : "initCause", "tail" : "(arg0: Throwable): Throwable", "member" : "java.lang.Throwable.initCause", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#initCause(x$1:Throwable):Throwable", "kind" : "def"}, {"label" : "getCause", "tail" : "(): Throwable", "member" : "java.lang.Throwable.getCause", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#getCause():Throwable", "kind" : "def"}, {"label" : "getLocalizedMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getLocalizedMessage", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#getLocalizedMessage():String", "kind" : "def"}, {"label" : "getMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getMessage", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#getMessage():String", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/FailedToWriteProcessInputException.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.MultipleProxErrors", "shortDescription" : "", "members_case class" : [{"label" : "toThrowable", "tail" : "(): Throwable", "member" : "io.github.vigoo.prox.MultipleProxErrors.toThrowable", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#toThrowable:Throwable", "kind" : "def"}, {"member" : "io.github.vigoo.prox.MultipleProxErrors#", "error" : "unsupported entity"}, {"label" : "errors", "tail" : ": List[ProxError]", "member" : "io.github.vigoo.prox.MultipleProxErrors.errors", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#errors:List[io.github.vigoo.prox.ProxError]", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/MultipleProxErrors.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.MultipleProxErrorsException", "shortDescription" : "", "members_case class" : [{"member" : "io.github.vigoo.prox.MultipleProxErrorsException#", "error" : "unsupported entity"}, {"label" : "value", "tail" : ": List[ProxError]", "member" : "io.github.vigoo.prox.MultipleProxErrorsException.value", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#value:List[io.github.vigoo.prox.ProxError]", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "getSuppressed", "tail" : "(): Array[Throwable]", "member" : "java.lang.Throwable.getSuppressed", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#getSuppressed():Array[Throwable]", "kind" : "final def"}, {"label" : "addSuppressed", "tail" : "(arg0: Throwable): Unit", "member" : "java.lang.Throwable.addSuppressed", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#addSuppressed(x$1:Throwable):Unit", "kind" : "final def"}, {"label" : "setStackTrace", "tail" : "(arg0: Array[StackTraceElement]): Unit", "member" : "java.lang.Throwable.setStackTrace", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#setStackTrace(x$1:Array[StackTraceElement]):Unit", "kind" : "def"}, {"label" : "getStackTrace", "tail" : "(): Array[StackTraceElement]", "member" : "java.lang.Throwable.getStackTrace", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#getStackTrace():Array[StackTraceElement]", "kind" : "def"}, {"label" : "fillInStackTrace", "tail" : "(): Throwable", "member" : "java.lang.Throwable.fillInStackTrace", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#fillInStackTrace():Throwable", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintWriter): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#printStackTrace(x$1:java.io.PrintWriter):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintStream): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#printStackTrace(x$1:java.io.PrintStream):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#printStackTrace():Unit", "kind" : "def"}, {"label" : "toString", "tail" : "(): String", "member" : "java.lang.Throwable.toString", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#toString():String", "kind" : "def"}, {"label" : "initCause", "tail" : "(arg0: Throwable): Throwable", "member" : "java.lang.Throwable.initCause", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#initCause(x$1:Throwable):Throwable", "kind" : "def"}, {"label" : "getCause", "tail" : "(): Throwable", "member" : "java.lang.Throwable.getCause", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#getCause():Throwable", "kind" : "def"}, {"label" : "getLocalizedMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getLocalizedMessage", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#getLocalizedMessage():String", "kind" : "def"}, {"label" : "getMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getMessage", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#getMessage():String", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/MultipleProxErrorsException.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.ProcessGroupModule", "trait" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html", "kind" : "trait", "members_trait" : [{"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup", "kind" : "object"}, {"label" : "ProcessGroupConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupConfiguration[O,E]extendsProcessGroupModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup[O,E]extendsProcessLikewithProcessGroupModule.this.ProcessGroupConfiguration[O,E]", "kind" : "trait"}, {"label" : "RunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.RunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#RunningProcessGroup[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.SimpleProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#SimpleProcessGroupResult[+O,+E]extendsProcessGroupModule.this.ProcessGroupResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.ProcessLike", "trait" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html", "kind" : "trait", "members_trait" : [{"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/package$$ProcessLike.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "shortDescription" : "Common base trait for processes and process groups, used in constraints inthe redirection traits"}, {"name" : "io.github.vigoo.prox.ProcessModule", "trait" : "io\/github\/vigoo\/prox\/ProcessModule.html", "kind" : "trait", "members_trait" : [{"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process", "kind" : "object"}, {"label" : "ProcessConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessConfigurationextendsProcessModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process[O,E]extendsProcessLikewithProcessModule.this.ProcessConfiguration", "kind" : "trait"}, {"label" : "RunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.RunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#RunningProcess[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.SimpleProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#SimpleProcessResult[+O,+E]extendsProcessModule.this.ProcessResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.ProcessRunnerModule", "trait" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html", "kind" : "trait", "members_trait" : [{"label" : "JVMProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerextendsProcessRunnerModule.this.JVMProcessRunnerBase[ProcessRunnerModule.this.JVMProcessInfo]", "kind" : "class"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase", "kind" : "object"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase[Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.ProcessRunner[Info]", "kind" : "abstract class"}, {"label" : "JVMRunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcessGroup[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcessGroup[O,E,Info]", "kind" : "class"}, {"label" : "JVMRunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcess[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcess[O,E,Info]", "kind" : "class"}, {"label" : "JVMProcessInfo", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessInfo", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessInfoextendsAnyRef", "kind" : "class"}, {"label" : "ProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.ProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#ProcessRunner[Info]extendsAnyRef", "kind" : "trait"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.Prox", "trait" : "io\/github\/vigoo\/prox\/package$$Prox.html", "kind" : "trait", "members_trait" : [{"label" : "ProcessStringContextIO", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessStringContextIO", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessStringContextIOextendsAnyRef", "kind" : "implicit class"}, {"label" : "PipeBuilderSyntax", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilderSyntax", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilderSyntax[P]extendsAnyRef", "kind" : "class"}, {"label" : "PipeBuilder", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilder", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilder[P]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessPiping", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessPiping", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessPipingextendsAnyRef", "kind" : "implicit class"}, {"label" : "JVMProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerextendsProcessRunnerModule.this.JVMProcessRunnerBase[ProcessRunnerModule.this.JVMProcessInfo]", "kind" : "class"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase", "kind" : "object"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase[Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.ProcessRunner[Info]", "kind" : "abstract class"}, {"label" : "JVMRunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcessGroup[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcessGroup[O,E,Info]", "kind" : "class"}, {"label" : "JVMRunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcess[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcess[O,E,Info]", "kind" : "class"}, {"label" : "JVMProcessInfo", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessInfo", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessInfoextendsAnyRef", "kind" : "class"}, {"label" : "ProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.ProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#ProcessRunner[Info]extendsAnyRef", "kind" : "trait"}, {"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType", "kind" : "object"}, {"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType", "kind" : "object"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "InputStream", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputStream", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputStreamextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputFileextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdIn", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdIn", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdInextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "AllCapturedToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedToSinkextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllCapturedThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedThroughPipe[O,OR]extendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToFileextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToStdErr", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToStdErr", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToStdErrextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "GroupErrorRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "OutputStreamToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamToSinkextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputStreamThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamThroughPipe[O,OR]extendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputFileextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdOut", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdOut", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdOutextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "RedirectableInput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableInput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableInput[+P<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors", "kind" : "object"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors[+P[_]<:RedirectionModule.this.ProcessGroup[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableError", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableError", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableError[+P[_]<:RedirectionModule.this.Process[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableOutput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableOutput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableOutput[+P[_]<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup", "kind" : "object"}, {"label" : "ProcessGroupConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupConfiguration[O,E]extendsProcessGroupModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup[O,E]extendsProcessLikewithProcessGroupModule.this.ProcessGroupConfiguration[O,E]", "kind" : "trait"}, {"label" : "RunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.RunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#RunningProcessGroup[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.SimpleProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#SimpleProcessGroupResult[+O,+E]extendsProcessGroupModule.this.ProcessGroupResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process", "kind" : "object"}, {"label" : "ProcessConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessConfigurationextendsProcessModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process[O,E]extendsProcessLikewithProcessModule.this.ProcessConfiguration", "kind" : "trait"}, {"label" : "RunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.RunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#RunningProcess[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.SimpleProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#SimpleProcessResult[+O,+E]extendsProcessModule.this.ProcessResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessLikeConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.CommonModule.ProcessLikeConfiguration", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#ProcessLikeConfigurationextendsAnyRef", "kind" : "trait"}, {"label" : "ListProxErrorOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ListProxErrorOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ListProxErrorOpsextendsAnyRef", "kind" : "implicit class"}, {"label" : "MonoidStreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.MonoidStreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#MonoidStreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "StreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.StreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#StreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "FiberOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.FiberOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#FiberOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "ResourceOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ResourceOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ResourceOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "IOOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.IOOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#IOOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}, {"label" : "startFiber", "tail" : "(f: ProxIO[A]): ProxIO[ProxFiber[A]]", "member" : "io.github.vigoo.prox.ProxRuntime.startFiber", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#startFiber[A](f:ProxRuntime.this.ProxIO[A]):ProxRuntime.this.ProxIO[ProxRuntime.this.ProxFiber[A]]", "kind" : "abstract def"}, {"label" : "drainToJavaOutputStream", "tail" : "(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.drainToJavaOutputStream", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#drainToJavaOutputStream(stream:ProxRuntime.this.ProxStream[Byte],output:java.io.OutputStream,flushChunks:Boolean):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "fromJavaInputStream", "tail" : "(input: java.io.InputStream, chunkSize: Int): ProxStream[Byte]", "member" : "io.github.vigoo.prox.ProxRuntime.fromJavaInputStream", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#fromJavaInputStream(input:java.io.InputStream,chunkSize:Int):ProxRuntime.this.ProxStream[Byte]", "kind" : "abstract def"}, {"label" : "runStreamTo", "tail" : "(s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.runStreamTo", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#runStreamTo[A](s:ProxRuntime.this.ProxStream[A],sink:ProxRuntime.this.ProxSink[A]):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "streamThrough", "tail" : "(s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]", "member" : "io.github.vigoo.prox.ProxRuntime.streamThrough", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#streamThrough[A,B](s:ProxRuntime.this.ProxStream[A],pipe:ProxRuntime.this.ProxPipe[A,B]):ProxRuntime.this.ProxStream[B]", "kind" : "abstract def"}, {"label" : "foldMonoidStream", "tail" : "(s: ProxStream[A])(arg0: ProxMonoid[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.foldMonoidStream", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#foldMonoidStream[A](s:ProxRuntime.this.ProxStream[A])(implicitevidence$1:ProxRuntime.this.ProxMonoid[A]):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "foldStream", "tail" : "(s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.foldStream", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#foldStream[A,B](s:ProxRuntime.this.ProxStream[A],init:B,f:(B,A)=>B):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "streamToVector", "tail" : "(s: ProxStream[A]): ProxIO[Vector[A]]", "member" : "io.github.vigoo.prox.ProxRuntime.streamToVector", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#streamToVector[A](s:ProxRuntime.this.ProxStream[A]):ProxRuntime.this.ProxIO[Vector[A]]", "kind" : "abstract def"}, {"label" : "drainStream", "tail" : "(s: ProxStream[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.drainStream", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#drainStream[A](s:ProxRuntime.this.ProxStream[A]):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "cancelFiber", "tail" : "(f: ProxFiber[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.cancelFiber", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#cancelFiber[A](f:ProxRuntime.this.ProxFiber[A]):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "joinFiber", "tail" : "(f: ProxFiber[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.joinFiber", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#joinFiber[A](f:ProxRuntime.this.ProxFiber[A]):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "useResource", "tail" : "(r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.useResource", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#useResource[A,B](r:ProxRuntime.this.ProxResource[A],f:A=>ProxRuntime.this.ProxIO[B]):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "makeResource", "tail" : "(acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]", "member" : "io.github.vigoo.prox.ProxRuntime.makeResource", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#makeResource[A](acquire:ProxRuntime.this.ProxIO[A],release:A=>ProxRuntime.this.ProxIO[Unit]):ProxRuntime.this.ProxResource[A]", "kind" : "abstract def"}, {"label" : "bracket", "tail" : "(acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.bracket", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#bracket[A,B](acquire:ProxRuntime.this.ProxIO[A])(use:A=>ProxRuntime.this.ProxIO[B])(fin:(A,io.github.vigoo.prox.IOResult)=>ProxRuntime.this.ProxIO[Unit]):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "identityPipe", "tail" : "(): ProxPipe[A, A]", "member" : "io.github.vigoo.prox.ProxRuntime.identityPipe", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#identityPipe[A]:ProxRuntime.this.ProxPipe[A,A]", "kind" : "abstract def"}, {"label" : "traverse", "tail" : "(list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]", "member" : "io.github.vigoo.prox.ProxRuntime.traverse", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#traverse[A,B](list:List[A])(f:A=>ProxRuntime.this.ProxIO[B]):ProxRuntime.this.ProxIO[List[B]]", "kind" : "abstract def"}, {"label" : "ioFlatMap", "tail" : "(io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.ioFlatMap", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#ioFlatMap[A,B](io:ProxRuntime.this.ProxIO[A],f:A=>ProxRuntime.this.ProxIO[B]):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "ioMap", "tail" : "(io: ProxIO[A], f: (A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.ioMap", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#ioMap[A,B](io:ProxRuntime.this.ProxIO[A],f:A=>B):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "raiseError", "tail" : "(error: ProxError): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.raiseError", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#raiseError(error:io.github.vigoo.prox.ProxError):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "blockingEffect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.blockingEffect", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#blockingEffect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "effect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.effect", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#effect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "pure", "tail" : "(value: A): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.pure", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#pure[A](value:A):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "unit", "tail" : "(): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.unit", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#unit:ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "exitCodeFromInt", "tail" : "(value: Int): ProxExitCode", "member" : "io.github.vigoo.prox.ProxRuntime.exitCodeFromInt", "link" : "io\/github\/vigoo\/prox\/package$$Prox.html#exitCodeFromInt(value:Int):ProxRuntime.this.ProxExitCode", "kind" : "abstract def"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxMonoid", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxStream", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxPipe", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxSink", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxResource", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxIO", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxFiber", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxExitCode", "error" : "unsupported entity"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.ProxError", "trait" : "io\/github\/vigoo\/prox\/ProxError.html", "kind" : "trait", "members_trait" : [{"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/ProxError.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/ProxError.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/ProxError.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/ProxError.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/ProxError.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/ProxError.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/ProxError.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/ProxError.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/ProxError.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/ProxError.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/ProxError.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/ProxError.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxError.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxError.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxError.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/ProxError.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/ProxError.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxError.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxError.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}, {"label" : "toThrowable", "tail" : "(): Throwable", "member" : "io.github.vigoo.prox.ProxError.toThrowable", "link" : "io\/github\/vigoo\/prox\/ProxError.html#toThrowable:Throwable", "kind" : "abstract def"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.ProxFS2", "object" : "io\/github\/vigoo\/prox\/ProxFS2$.html", "members_object" : [{"label" : "apply", "tail" : "(a: Async[F]): ProxFS2[F]", "member" : "io.github.vigoo.prox.ProxFS2.apply", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#apply[F[_]](implicita:cats.effect.Async[F]):io.github.vigoo.prox.ProxFS2[F]", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxFS2$.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "trait" : "io\/github\/vigoo\/prox\/ProxFS2.html", "kind" : "trait", "members_trait" : [{"label" : "ProcessStringContextIO", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessStringContextIO", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessStringContextIOextendsAnyRef", "kind" : "implicit class"}, {"label" : "PipeBuilderSyntax", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilderSyntax", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilderSyntax[P]extendsAnyRef", "kind" : "class"}, {"label" : "PipeBuilder", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilder", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilder[P]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessPiping", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessPiping", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessPipingextendsAnyRef", "kind" : "implicit class"}, {"label" : "JVMProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerextendsProcessRunnerModule.this.JVMProcessRunnerBase[ProcessRunnerModule.this.JVMProcessInfo]", "kind" : "class"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase", "kind" : "object"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase[Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.ProcessRunner[Info]", "kind" : "abstract class"}, {"label" : "JVMRunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcessGroup[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcessGroup[O,E,Info]", "kind" : "class"}, {"label" : "JVMRunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcess[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcess[O,E,Info]", "kind" : "class"}, {"label" : "JVMProcessInfo", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessInfo", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessInfoextendsAnyRef", "kind" : "class"}, {"label" : "ProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.ProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#ProcessRunner[Info]extendsAnyRef", "kind" : "trait"}, {"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType", "kind" : "object"}, {"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType", "kind" : "object"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "InputStream", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputStream", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputStreamextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputFileextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdIn", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdIn", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdInextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "AllCapturedToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedToSinkextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllCapturedThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedThroughPipe[O,OR]extendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToFileextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToStdErr", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToStdErr", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToStdErrextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "GroupErrorRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "OutputStreamToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamToSinkextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputStreamThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamThroughPipe[O,OR]extendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputFileextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdOut", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdOut", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdOutextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "RedirectableInput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableInput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableInput[+P<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors", "kind" : "object"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors[+P[_]<:RedirectionModule.this.ProcessGroup[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableError", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableError", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableError[+P[_]<:RedirectionModule.this.Process[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableOutput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableOutput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableOutput[+P[_]<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup", "kind" : "object"}, {"label" : "ProcessGroupConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupConfiguration[O,E]extendsProcessGroupModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup[O,E]extendsProcessLikewithProcessGroupModule.this.ProcessGroupConfiguration[O,E]", "kind" : "trait"}, {"label" : "RunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.RunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#RunningProcessGroup[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.SimpleProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#SimpleProcessGroupResult[+O,+E]extendsProcessGroupModule.this.ProcessGroupResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process", "kind" : "object"}, {"label" : "ProcessConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessConfigurationextendsProcessModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process[O,E]extendsProcessLikewithProcessModule.this.ProcessConfiguration", "kind" : "trait"}, {"label" : "RunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.RunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#RunningProcess[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.SimpleProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#SimpleProcessResult[+O,+E]extendsProcessModule.this.ProcessResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessLikeConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.CommonModule.ProcessLikeConfiguration", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#ProcessLikeConfigurationextendsAnyRef", "kind" : "trait"}, {"label" : "ListProxErrorOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ListProxErrorOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ListProxErrorOpsextendsAnyRef", "kind" : "implicit class"}, {"label" : "MonoidStreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.MonoidStreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#MonoidStreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "StreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.StreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#StreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "FiberOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.FiberOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#FiberOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "ResourceOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ResourceOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ResourceOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "IOOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.IOOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#IOOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "drainToJavaOutputStream", "tail" : "(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxFS2.drainToJavaOutputStream", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#drainToJavaOutputStream(stream:ProxFS2.this.ProxStream[Byte],output:java.io.OutputStream,flushChunks:Boolean):ProxFS2.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "fromJavaInputStream", "tail" : "(input: java.io.InputStream, chunkSize: Int): ProxStream[Byte]", "member" : "io.github.vigoo.prox.ProxFS2.fromJavaInputStream", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#fromJavaInputStream(input:java.io.InputStream,chunkSize:Int):ProxFS2.this.ProxStream[Byte]", "kind" : "final def"}, {"label" : "runStreamTo", "tail" : "(s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxFS2.runStreamTo", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#runStreamTo[A](s:ProxFS2.this.ProxStream[A],sink:ProxFS2.this.ProxSink[A]):ProxFS2.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "streamThrough", "tail" : "(s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]", "member" : "io.github.vigoo.prox.ProxFS2.streamThrough", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#streamThrough[A,B](s:ProxFS2.this.ProxStream[A],pipe:ProxFS2.this.ProxPipe[A,B]):ProxFS2.this.ProxStream[B]", "kind" : "final def"}, {"label" : "foldMonoidStream", "tail" : "(s: ProxStream[A])(arg0: ProxMonoid[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxFS2.foldMonoidStream", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#foldMonoidStream[A](s:ProxFS2.this.ProxStream[A])(implicitevidence$1:ProxFS2.this.ProxMonoid[A]):ProxFS2.this.ProxIO[A]", "kind" : "final def"}, {"label" : "foldStream", "tail" : "(s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxFS2.foldStream", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#foldStream[A,B](s:ProxFS2.this.ProxStream[A],init:B,f:(B,A)=>B):ProxFS2.this.ProxIO[B]", "kind" : "final def"}, {"label" : "streamToVector", "tail" : "(s: ProxStream[A]): ProxIO[Vector[A]]", "member" : "io.github.vigoo.prox.ProxFS2.streamToVector", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#streamToVector[A](s:ProxFS2.this.ProxStream[A]):ProxFS2.this.ProxIO[Vector[A]]", "kind" : "final def"}, {"label" : "drainStream", "tail" : "(s: ProxStream[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxFS2.drainStream", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#drainStream[A](s:ProxFS2.this.ProxStream[A]):ProxFS2.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "startFiber", "tail" : "(f: ProxIO[A]): ProxIO[ProxFiber[A]]", "member" : "io.github.vigoo.prox.ProxFS2.startFiber", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#startFiber[A](f:ProxFS2.this.ProxIO[A]):ProxFS2.this.ProxIO[ProxFS2.this.ProxFiber[A]]", "kind" : "final def"}, {"label" : "cancelFiber", "tail" : "(f: ProxFiber[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxFS2.cancelFiber", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#cancelFiber[A](f:ProxFS2.this.ProxFiber[A]):ProxFS2.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "joinFiber", "tail" : "(f: ProxFiber[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxFS2.joinFiber", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#joinFiber[A](f:ProxFS2.this.ProxFiber[A]):ProxFS2.this.ProxIO[A]", "kind" : "final def"}, {"label" : "useResource", "tail" : "(r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxFS2.useResource", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#useResource[A,B](r:ProxFS2.this.ProxResource[A],f:A=>ProxFS2.this.ProxIO[B]):ProxFS2.this.ProxIO[B]", "kind" : "final def"}, {"label" : "makeResource", "tail" : "(acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]", "member" : "io.github.vigoo.prox.ProxFS2.makeResource", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#makeResource[A](acquire:ProxFS2.this.ProxIO[A],release:A=>ProxFS2.this.ProxIO[Unit]):ProxFS2.this.ProxResource[A]", "kind" : "final def"}, {"label" : "bracket", "tail" : "(acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxFS2.bracket", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#bracket[A,B](acquire:ProxFS2.this.ProxIO[A])(use:A=>ProxFS2.this.ProxIO[B])(fin:(A,io.github.vigoo.prox.IOResult)=>ProxFS2.this.ProxIO[Unit]):ProxFS2.this.ProxIO[B]", "kind" : "final def"}, {"label" : "identityPipe", "tail" : "(): ProxPipe[A, A]", "member" : "io.github.vigoo.prox.ProxFS2.identityPipe", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#identityPipe[A]:ProxFS2.this.ProxPipe[A,A]", "kind" : "final def"}, {"label" : "traverse", "tail" : "(list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]", "member" : "io.github.vigoo.prox.ProxFS2.traverse", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#traverse[A,B](list:List[A])(f:A=>ProxFS2.this.ProxIO[B]):ProxFS2.this.ProxIO[List[B]]", "kind" : "final def"}, {"label" : "ioFlatMap", "tail" : "(io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxFS2.ioFlatMap", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ioFlatMap[A,B](io:ProxFS2.this.ProxIO[A],f:A=>ProxFS2.this.ProxIO[B]):ProxFS2.this.ProxIO[B]", "kind" : "final def"}, {"label" : "ioMap", "tail" : "(io: ProxIO[A], f: (A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxFS2.ioMap", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ioMap[A,B](io:ProxFS2.this.ProxIO[A],f:A=>B):ProxFS2.this.ProxIO[B]", "kind" : "final def"}, {"label" : "raiseError", "tail" : "(error: ProxError): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxFS2.raiseError", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#raiseError(error:io.github.vigoo.prox.ProxError):ProxFS2.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "blockingEffect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxFS2.blockingEffect", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#blockingEffect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxFS2.this.ProxIO[A]", "kind" : "final def"}, {"label" : "effect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxFS2.effect", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#effect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxFS2.this.ProxIO[A]", "kind" : "final def"}, {"label" : "pure", "tail" : "(value: A): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxFS2.pure", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#pure[A](value:A):ProxFS2.this.ProxIO[A]", "kind" : "final def"}, {"label" : "unit", "tail" : "(): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxFS2.unit", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#unit:ProxFS2.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "exitCodeFromInt", "tail" : "(value: Int): ProxExitCode", "member" : "io.github.vigoo.prox.ProxFS2.exitCodeFromInt", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#exitCodeFromInt(value:Int):ProxFS2.this.ProxExitCode", "kind" : "final def"}, {"label" : "ProxMonoid", "tail" : "", "member" : "io.github.vigoo.prox.ProxFS2.ProxMonoid", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ProxMonoid[A]=cats.kernel.Monoid[A]", "kind" : "type"}, {"label" : "ProxStream", "tail" : "", "member" : "io.github.vigoo.prox.ProxFS2.ProxStream", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ProxStream[A]=fs2.Stream[F,A]", "kind" : "type"}, {"label" : "ProxSink", "tail" : "", "member" : "io.github.vigoo.prox.ProxFS2.ProxSink", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ProxSink[A]=fs2.Pipe[F,A,Unit]", "kind" : "type"}, {"label" : "ProxPipe", "tail" : "", "member" : "io.github.vigoo.prox.ProxFS2.ProxPipe", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ProxPipe[A,B]=fs2.Pipe[F,A,B]", "kind" : "type"}, {"label" : "ProxResource", "tail" : "", "member" : "io.github.vigoo.prox.ProxFS2.ProxResource", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ProxResource[A]=cats.effect.Resource[F,A]", "kind" : "type"}, {"label" : "ProxIO", "tail" : "", "member" : "io.github.vigoo.prox.ProxFS2.ProxIO", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ProxIO[A]=F[A]", "kind" : "type"}, {"label" : "ProxFiber", "tail" : "", "member" : "io.github.vigoo.prox.ProxFS2.ProxFiber", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ProxFiber[A]=cats.effect.Fiber[F,Throwable,A]", "kind" : "type"}, {"label" : "ProxExitCode", "tail" : "", "member" : "io.github.vigoo.prox.ProxFS2.ProxExitCode", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ProxExitCode=cats.effect.ExitCode", "kind" : "type"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}, {"label" : "instances", "tail" : ": Sync[F] with Concurrent[F]", "member" : "io.github.vigoo.prox.ProxFS2.instances", "link" : "io\/github\/vigoo\/prox\/ProxFS2.html#instances:cats.effect.Sync[F]withcats.effect.Concurrent[F]", "kind" : "abstract val"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.ProxRuntime", "trait" : "io\/github\/vigoo\/prox\/ProxRuntime.html", "kind" : "trait", "members_trait" : [{"label" : "ListProxErrorOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ListProxErrorOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ListProxErrorOpsextendsAnyRef", "kind" : "implicit class"}, {"label" : "MonoidStreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.MonoidStreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#MonoidStreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "StreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.StreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#StreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "FiberOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.FiberOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#FiberOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "ResourceOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ResourceOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ResourceOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "IOOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.IOOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#IOOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}, {"label" : "startFiber", "tail" : "(f: ProxIO[A]): ProxIO[ProxFiber[A]]", "member" : "io.github.vigoo.prox.ProxRuntime.startFiber", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#startFiber[A](f:ProxRuntime.this.ProxIO[A]):ProxRuntime.this.ProxIO[ProxRuntime.this.ProxFiber[A]]", "kind" : "abstract def"}, {"label" : "drainToJavaOutputStream", "tail" : "(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.drainToJavaOutputStream", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#drainToJavaOutputStream(stream:ProxRuntime.this.ProxStream[Byte],output:java.io.OutputStream,flushChunks:Boolean):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "fromJavaInputStream", "tail" : "(input: InputStream, chunkSize: Int): ProxStream[Byte]", "member" : "io.github.vigoo.prox.ProxRuntime.fromJavaInputStream", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#fromJavaInputStream(input:java.io.InputStream,chunkSize:Int):ProxRuntime.this.ProxStream[Byte]", "kind" : "abstract def"}, {"label" : "runStreamTo", "tail" : "(s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.runStreamTo", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#runStreamTo[A](s:ProxRuntime.this.ProxStream[A],sink:ProxRuntime.this.ProxSink[A]):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "streamThrough", "tail" : "(s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]", "member" : "io.github.vigoo.prox.ProxRuntime.streamThrough", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#streamThrough[A,B](s:ProxRuntime.this.ProxStream[A],pipe:ProxRuntime.this.ProxPipe[A,B]):ProxRuntime.this.ProxStream[B]", "kind" : "abstract def"}, {"label" : "foldMonoidStream", "tail" : "(s: ProxStream[A])(arg0: ProxMonoid[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.foldMonoidStream", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#foldMonoidStream[A](s:ProxRuntime.this.ProxStream[A])(implicitevidence$1:ProxRuntime.this.ProxMonoid[A]):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "foldStream", "tail" : "(s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.foldStream", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#foldStream[A,B](s:ProxRuntime.this.ProxStream[A],init:B,f:(B,A)=>B):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "streamToVector", "tail" : "(s: ProxStream[A]): ProxIO[Vector[A]]", "member" : "io.github.vigoo.prox.ProxRuntime.streamToVector", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#streamToVector[A](s:ProxRuntime.this.ProxStream[A]):ProxRuntime.this.ProxIO[Vector[A]]", "kind" : "abstract def"}, {"label" : "drainStream", "tail" : "(s: ProxStream[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.drainStream", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#drainStream[A](s:ProxRuntime.this.ProxStream[A]):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "cancelFiber", "tail" : "(f: ProxFiber[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.cancelFiber", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#cancelFiber[A](f:ProxRuntime.this.ProxFiber[A]):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "joinFiber", "tail" : "(f: ProxFiber[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.joinFiber", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#joinFiber[A](f:ProxRuntime.this.ProxFiber[A]):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "useResource", "tail" : "(r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.useResource", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#useResource[A,B](r:ProxRuntime.this.ProxResource[A],f:A=>ProxRuntime.this.ProxIO[B]):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "makeResource", "tail" : "(acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]", "member" : "io.github.vigoo.prox.ProxRuntime.makeResource", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#makeResource[A](acquire:ProxRuntime.this.ProxIO[A],release:A=>ProxRuntime.this.ProxIO[Unit]):ProxRuntime.this.ProxResource[A]", "kind" : "abstract def"}, {"label" : "bracket", "tail" : "(acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.bracket", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#bracket[A,B](acquire:ProxRuntime.this.ProxIO[A])(use:A=>ProxRuntime.this.ProxIO[B])(fin:(A,io.github.vigoo.prox.IOResult)=>ProxRuntime.this.ProxIO[Unit]):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "identityPipe", "tail" : "(): ProxPipe[A, A]", "member" : "io.github.vigoo.prox.ProxRuntime.identityPipe", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#identityPipe[A]:ProxRuntime.this.ProxPipe[A,A]", "kind" : "abstract def"}, {"label" : "traverse", "tail" : "(list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]", "member" : "io.github.vigoo.prox.ProxRuntime.traverse", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#traverse[A,B](list:List[A])(f:A=>ProxRuntime.this.ProxIO[B]):ProxRuntime.this.ProxIO[List[B]]", "kind" : "abstract def"}, {"label" : "ioFlatMap", "tail" : "(io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.ioFlatMap", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ioFlatMap[A,B](io:ProxRuntime.this.ProxIO[A],f:A=>ProxRuntime.this.ProxIO[B]):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "ioMap", "tail" : "(io: ProxIO[A], f: (A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxRuntime.ioMap", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ioMap[A,B](io:ProxRuntime.this.ProxIO[A],f:A=>B):ProxRuntime.this.ProxIO[B]", "kind" : "abstract def"}, {"label" : "raiseError", "tail" : "(error: ProxError): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.raiseError", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#raiseError(error:io.github.vigoo.prox.ProxError):ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "blockingEffect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.blockingEffect", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#blockingEffect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "effect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.effect", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#effect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "pure", "tail" : "(value: A): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxRuntime.pure", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#pure[A](value:A):ProxRuntime.this.ProxIO[A]", "kind" : "abstract def"}, {"label" : "unit", "tail" : "(): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxRuntime.unit", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#unit:ProxRuntime.this.ProxIO[Unit]", "kind" : "abstract def"}, {"label" : "exitCodeFromInt", "tail" : "(value: Int): ProxExitCode", "member" : "io.github.vigoo.prox.ProxRuntime.exitCodeFromInt", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#exitCodeFromInt(value:Int):ProxRuntime.this.ProxExitCode", "kind" : "abstract def"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxMonoid", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxStream", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxPipe", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxSink", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxResource", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxIO", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxFiber", "error" : "unsupported entity"}, {"member" : "io.github.vigoo.prox.ProxRuntime.ProxExitCode", "error" : "unsupported entity"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.ProxZStream", "trait" : "io\/github\/vigoo\/prox\/ProxZStream.html", "kind" : "trait", "members_trait" : [{"label" : "ProcessStringContextIO", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessStringContextIO", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessStringContextIOextendsAnyRef", "kind" : "implicit class"}, {"label" : "PipeBuilderSyntax", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilderSyntax", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilderSyntax[P]extendsAnyRef", "kind" : "class"}, {"label" : "PipeBuilder", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilder", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilder[P]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessPiping", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessPiping", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessPipingextendsAnyRef", "kind" : "implicit class"}, {"label" : "JVMProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerextendsProcessRunnerModule.this.JVMProcessRunnerBase[ProcessRunnerModule.this.JVMProcessInfo]", "kind" : "class"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase", "kind" : "object"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase[Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.ProcessRunner[Info]", "kind" : "abstract class"}, {"label" : "JVMRunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcessGroup[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcessGroup[O,E,Info]", "kind" : "class"}, {"label" : "JVMRunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcess[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcess[O,E,Info]", "kind" : "class"}, {"label" : "JVMProcessInfo", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessInfo", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessInfoextendsAnyRef", "kind" : "class"}, {"label" : "ProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.ProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#ProcessRunner[Info]extendsAnyRef", "kind" : "trait"}, {"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType", "kind" : "object"}, {"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType", "kind" : "object"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "InputStream", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputStream", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputStreamextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputFileextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdIn", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdIn", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdInextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "AllCapturedToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedToSinkextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllCapturedThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedThroughPipe[O,OR]extendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToFileextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToStdErr", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToStdErr", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToStdErrextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "GroupErrorRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "OutputStreamToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamToSinkextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputStreamThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamThroughPipe[O,OR]extendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputFileextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdOut", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdOut", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdOutextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "RedirectableInput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableInput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableInput[+P<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors", "kind" : "object"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors[+P[_]<:RedirectionModule.this.ProcessGroup[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableError", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableError", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableError[+P[_]<:RedirectionModule.this.Process[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableOutput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableOutput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableOutput[+P[_]<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup", "kind" : "object"}, {"label" : "ProcessGroupConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupConfiguration[O,E]extendsProcessGroupModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup[O,E]extendsProcessLikewithProcessGroupModule.this.ProcessGroupConfiguration[O,E]", "kind" : "trait"}, {"label" : "RunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.RunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#RunningProcessGroup[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.SimpleProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#SimpleProcessGroupResult[+O,+E]extendsProcessGroupModule.this.ProcessGroupResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process", "kind" : "object"}, {"label" : "ProcessConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessConfigurationextendsProcessModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process[O,E]extendsProcessLikewithProcessModule.this.ProcessConfiguration", "kind" : "trait"}, {"label" : "RunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.RunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#RunningProcess[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.SimpleProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#SimpleProcessResult[+O,+E]extendsProcessModule.this.ProcessResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessLikeConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.CommonModule.ProcessLikeConfiguration", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#ProcessLikeConfigurationextendsAnyRef", "kind" : "trait"}, {"label" : "ListProxErrorOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ListProxErrorOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ListProxErrorOpsextendsAnyRef", "kind" : "implicit class"}, {"label" : "MonoidStreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.MonoidStreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#MonoidStreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "StreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.StreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#StreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "FiberOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.FiberOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#FiberOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "ResourceOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ResourceOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ResourceOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "IOOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.IOOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#IOOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "sinkAsTransformAndSink", "tail" : "(sink: ZSink[Any, ProxError, A, Any, Unit]): TransformAndSink[A, A]", "member" : "io.github.vigoo.prox.ProxZStream.sinkAsTransformAndSink", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#sinkAsTransformAndSink[A](sink:zio.stream.ZSink[Any,io.github.vigoo.prox.ProxError,A,Any,Unit]):ProxZStream.this.TransformAndSink[A,A]", "kind" : "implicit def"}, {"label" : "transducerAsPipeThrowable", "tail" : "(transducer: ZPipeline[Any, Throwable, A, B]): ProxPipe[A, B]", "member" : "io.github.vigoo.prox.ProxZStream.transducerAsPipeThrowable", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#transducerAsPipeThrowable[A,B](transducer:zio.stream.ZPipeline[Any,Throwable,A,B]):ProxZStream.this.ProxPipe[A,B]", "kind" : "implicit def"}, {"label" : "transducerAsPipe", "tail" : "(transducer: ZPipeline[Any, ProxError, A, B]): ProxPipe[A, B]", "member" : "io.github.vigoo.prox.ProxZStream.transducerAsPipe", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#transducerAsPipe[A,B](transducer:zio.stream.ZPipeline[Any,io.github.vigoo.prox.ProxError,A,B]):ProxZStream.this.ProxPipe[A,B]", "kind" : "implicit def"}, {"label" : "startFiber", "tail" : "(f: ProxIO[A]): ProxIO[ProxFiber[A]]", "member" : "io.github.vigoo.prox.ProxZStream.startFiber", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#startFiber[A](f:ProxZStream.this.ProxIO[A]):ProxZStream.this.ProxIO[ProxZStream.this.ProxFiber[A]]", "kind" : "final def"}, {"label" : "drainToJavaOutputStream", "tail" : "(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.drainToJavaOutputStream", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#drainToJavaOutputStream(stream:ProxZStream.this.ProxStream[Byte],output:java.io.OutputStream,flushChunks:Boolean):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "fromJavaInputStream", "tail" : "(input: java.io.InputStream, chunkSize: Int): ProxStream[Byte]", "member" : "io.github.vigoo.prox.ProxZStream.fromJavaInputStream", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#fromJavaInputStream(input:java.io.InputStream,chunkSize:Int):ProxZStream.this.ProxStream[Byte]", "kind" : "final def"}, {"label" : "runStreamTo", "tail" : "(s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.runStreamTo", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#runStreamTo[A](s:ProxZStream.this.ProxStream[A],sink:ProxZStream.this.ProxSink[A]):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "streamThrough", "tail" : "(s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]", "member" : "io.github.vigoo.prox.ProxZStream.streamThrough", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#streamThrough[A,B](s:ProxZStream.this.ProxStream[A],pipe:ProxZStream.this.ProxPipe[A,B]):ProxZStream.this.ProxStream[B]", "kind" : "final def"}, {"label" : "foldMonoidStream", "tail" : "(s: ProxStream[A])(arg0: Identity[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.foldMonoidStream", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#foldMonoidStream[A](s:ProxZStream.this.ProxStream[A])(implicitevidence$1:zio.prelude.Identity[A]):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "foldStream", "tail" : "(s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.foldStream", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#foldStream[A,B](s:ProxZStream.this.ProxStream[A],init:B,f:(B,A)=>B):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "streamToVector", "tail" : "(s: ProxStream[A]): ProxIO[Vector[A]]", "member" : "io.github.vigoo.prox.ProxZStream.streamToVector", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#streamToVector[A](s:ProxZStream.this.ProxStream[A]):ProxZStream.this.ProxIO[Vector[A]]", "kind" : "final def"}, {"label" : "drainStream", "tail" : "(s: ProxStream[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.drainStream", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#drainStream[A](s:ProxZStream.this.ProxStream[A]):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "cancelFiber", "tail" : "(f: ProxFiber[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.cancelFiber", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#cancelFiber[A](f:ProxZStream.this.ProxFiber[A]):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "joinFiber", "tail" : "(f: ProxFiber[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.joinFiber", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#joinFiber[A](f:ProxZStream.this.ProxFiber[A]):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "useResource", "tail" : "(r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.useResource", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#useResource[A,B](r:ProxZStream.this.ProxResource[A],f:A=>ProxZStream.this.ProxIO[B]):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "makeResource", "tail" : "(acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]", "member" : "io.github.vigoo.prox.ProxZStream.makeResource", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#makeResource[A](acquire:ProxZStream.this.ProxIO[A],release:A=>ProxZStream.this.ProxIO[Unit]):ProxZStream.this.ProxResource[A]", "kind" : "final def"}, {"label" : "bracket", "tail" : "(acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.bracket", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#bracket[A,B](acquire:ProxZStream.this.ProxIO[A])(use:A=>ProxZStream.this.ProxIO[B])(fin:(A,io.github.vigoo.prox.IOResult)=>ProxZStream.this.ProxIO[Unit]):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "identityPipe", "tail" : "(): ProxPipe[A, A]", "member" : "io.github.vigoo.prox.ProxZStream.identityPipe", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#identityPipe[A]:ProxZStream.this.ProxPipe[A,A]", "kind" : "final def"}, {"label" : "traverse", "tail" : "(list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]", "member" : "io.github.vigoo.prox.ProxZStream.traverse", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#traverse[A,B](list:List[A])(f:A=>ProxZStream.this.ProxIO[B]):ProxZStream.this.ProxIO[List[B]]", "kind" : "final def"}, {"label" : "ioFlatMap", "tail" : "(io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.ioFlatMap", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ioFlatMap[A,B](io:ProxZStream.this.ProxIO[A],f:A=>ProxZStream.this.ProxIO[B]):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "ioMap", "tail" : "(io: ProxIO[A], f: (A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.ioMap", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ioMap[A,B](io:ProxZStream.this.ProxIO[A],f:A=>B):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "raiseError", "tail" : "(error: ProxError): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.raiseError", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#raiseError(error:io.github.vigoo.prox.ProxError):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "blockingEffect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.blockingEffect", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#blockingEffect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "effect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.effect", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#effect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "pure", "tail" : "(value: A): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.pure", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#pure[A](value:A):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "unit", "tail" : "(): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.unit", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#unit:ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "exitCodeFromInt", "tail" : "(value: Int): ProxExitCode", "member" : "io.github.vigoo.prox.ProxZStream.exitCodeFromInt", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#exitCodeFromInt(value:Int):ProxZStream.this.ProxExitCode", "kind" : "final def"}, {"label" : "ProxMonoid", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxMonoid", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ProxMonoid[A]=zio.prelude.Identity[A]", "kind" : "type"}, {"label" : "ProxSink", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxSink", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ProxSink[A]=ProxZStream.this.TransformAndSink[A,_]", "kind" : "type"}, {"label" : "ProxPipe", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxPipe", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ProxPipe[A,B]=ProxZStream.this.ProxStream[A]=>ProxZStream.this.ProxStream[B]", "kind" : "type"}, {"label" : "ProxStream", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxStream", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ProxStream[A]=zio.stream.ZStream[Any,io.github.vigoo.prox.ProxError,A]", "kind" : "type"}, {"label" : "ProxResource", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxResource", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ProxResource[A]=zio.ZIO[zio.Scope,io.github.vigoo.prox.ProxError,A]", "kind" : "type"}, {"label" : "ProxIO", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxIO", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ProxIO[A]=zio.ZIO[Any,io.github.vigoo.prox.ProxError,A]", "kind" : "type"}, {"label" : "ProxFiber", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxFiber", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ProxFiber[A]=zio.Fiber[io.github.vigoo.prox.ProxError,A]", "kind" : "type"}, {"label" : "ProxExitCode", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxExitCode", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ProxExitCode=zio.ExitCode", "kind" : "type"}, {"label" : "TransformAndSink", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.TransformAndSink", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#TransformAndSink", "kind" : "object"}, {"label" : "TransformAndSink", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.TransformAndSink", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#TransformAndSink[A,B]extendsProductwithSerializable", "kind" : "case class"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.RedirectionModule", "trait" : "io\/github\/vigoo\/prox\/RedirectionModule.html", "kind" : "trait", "members_trait" : [{"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType", "kind" : "object"}, {"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType", "kind" : "object"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "InputStream", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputStream", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputStreamextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputFileextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdIn", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdIn", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdInextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "AllCapturedToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedToSinkextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllCapturedThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedThroughPipe[O,OR]extendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToFileextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToStdErr", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToStdErr", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToStdErrextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "GroupErrorRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "OutputStreamToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamToSinkextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputStreamThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamThroughPipe[O,OR]extendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputFileextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdOut", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdOut", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdOutextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "RedirectableInput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableInput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableInput[+P<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors", "kind" : "object"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors[+P[_]<:RedirectionModule.this.ProcessGroup[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableError", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableError", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableError[+P[_]<:RedirectionModule.this.Process[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableOutput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableOutput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableOutput[+P[_]<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.SyntaxModule", "trait" : "io\/github\/vigoo\/prox\/SyntaxModule.html", "kind" : "trait", "members_trait" : [{"label" : "ProcessStringContextIO", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessStringContextIO", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessStringContextIOextendsAnyRef", "kind" : "implicit class"}, {"label" : "PipeBuilderSyntax", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilderSyntax", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilderSyntax[P]extendsAnyRef", "kind" : "class"}, {"label" : "PipeBuilder", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilder", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilder[P]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessPiping", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessPiping", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessPipingextendsAnyRef", "kind" : "implicit class"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "shortDescription" : ""}, {"name" : "io.github.vigoo.prox.UnknownProxError", "shortDescription" : "", "members_case class" : [{"label" : "toThrowable", "tail" : "(): Throwable", "member" : "io.github.vigoo.prox.UnknownProxError.toThrowable", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#toThrowable:Throwable", "kind" : "def"}, {"member" : "io.github.vigoo.prox.UnknownProxError#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.UnknownProxError.reason", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/UnknownProxError.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/UnknownProxError.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.UnknownProxErrorException", "shortDescription" : "", "members_case class" : [{"member" : "io.github.vigoo.prox.UnknownProxErrorException#", "error" : "unsupported entity"}, {"label" : "reason", "tail" : ": Throwable", "member" : "io.github.vigoo.prox.UnknownProxErrorException.reason", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#reason:Throwable", "kind" : "val"}, {"label" : "productElementNames", "tail" : "(): Iterator[String]", "member" : "scala.Product.productElementNames", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#productElementNames:Iterator[String]", "kind" : "def"}, {"label" : "getSuppressed", "tail" : "(): Array[Throwable]", "member" : "java.lang.Throwable.getSuppressed", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#getSuppressed():Array[Throwable]", "kind" : "final def"}, {"label" : "addSuppressed", "tail" : "(arg0: Throwable): Unit", "member" : "java.lang.Throwable.addSuppressed", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#addSuppressed(x$1:Throwable):Unit", "kind" : "final def"}, {"label" : "setStackTrace", "tail" : "(arg0: Array[StackTraceElement]): Unit", "member" : "java.lang.Throwable.setStackTrace", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#setStackTrace(x$1:Array[StackTraceElement]):Unit", "kind" : "def"}, {"label" : "getStackTrace", "tail" : "(): Array[StackTraceElement]", "member" : "java.lang.Throwable.getStackTrace", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#getStackTrace():Array[StackTraceElement]", "kind" : "def"}, {"label" : "fillInStackTrace", "tail" : "(): Throwable", "member" : "java.lang.Throwable.fillInStackTrace", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#fillInStackTrace():Throwable", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintWriter): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#printStackTrace(x$1:java.io.PrintWriter):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(arg0: PrintStream): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#printStackTrace(x$1:java.io.PrintStream):Unit", "kind" : "def"}, {"label" : "printStackTrace", "tail" : "(): Unit", "member" : "java.lang.Throwable.printStackTrace", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#printStackTrace():Unit", "kind" : "def"}, {"label" : "toString", "tail" : "(): String", "member" : "java.lang.Throwable.toString", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#toString():String", "kind" : "def"}, {"label" : "initCause", "tail" : "(arg0: Throwable): Throwable", "member" : "java.lang.Throwable.initCause", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#initCause(x$1:Throwable):Throwable", "kind" : "def"}, {"label" : "getCause", "tail" : "(): Throwable", "member" : "java.lang.Throwable.getCause", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#getCause():Throwable", "kind" : "def"}, {"label" : "getLocalizedMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getLocalizedMessage", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#getLocalizedMessage():String", "kind" : "def"}, {"label" : "getMessage", "tail" : "(): String", "member" : "java.lang.Throwable.getMessage", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#getMessage():String", "kind" : "def"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#clone():Object", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "case class" : "io\/github\/vigoo\/prox\/UnknownProxErrorException.html", "kind" : "case class"}, {"name" : "io.github.vigoo.prox.zstream", "shortDescription" : "", "object" : "io\/github\/vigoo\/prox\/zstream$.html", "members_object" : [{"label" : "TransformAndSink", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.TransformAndSink", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#TransformAndSink", "kind" : "object"}, {"label" : "TransformAndSink", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.TransformAndSink", "link" : "io\/github\/vigoo\/prox\/ProxZStream.html#TransformAndSink[A,B]extendsProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessStringContextIO", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessStringContextIO", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessStringContextIOextendsAnyRef", "kind" : "implicit class"}, {"label" : "PipeBuilderSyntax", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilderSyntax", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilderSyntax[P]extendsAnyRef", "kind" : "class"}, {"label" : "PipeBuilder", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.PipeBuilder", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#PipeBuilder[P]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessPiping", "tail" : "", "member" : "io.github.vigoo.prox.SyntaxModule.ProcessPiping", "link" : "io\/github\/vigoo\/prox\/SyntaxModule.html#ProcessPipingextendsAnyRef", "kind" : "implicit class"}, {"label" : "JVMProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerextendsProcessRunnerModule.this.JVMProcessRunnerBase[ProcessRunnerModule.this.JVMProcessInfo]", "kind" : "class"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase", "kind" : "object"}, {"label" : "JVMProcessRunnerBase", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessRunnerBase", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessRunnerBase[Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.ProcessRunner[Info]", "kind" : "abstract class"}, {"label" : "JVMRunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcessGroup[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcessGroup[O,E,Info]", "kind" : "class"}, {"label" : "JVMRunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMRunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMRunningProcess[O,E,+Info<:ProcessRunnerModule.this.JVMProcessInfo]extendsProcessRunnerModule.this.RunningProcess[O,E,Info]", "kind" : "class"}, {"label" : "JVMProcessInfo", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.JVMProcessInfo", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#JVMProcessInfoextendsAnyRef", "kind" : "class"}, {"label" : "ProcessRunner", "tail" : "", "member" : "io.github.vigoo.prox.ProcessRunnerModule.ProcessRunner", "link" : "io\/github\/vigoo\/prox\/ProcessRunnerModule.html#ProcessRunner[Info]extendsAnyRef", "kind" : "trait"}, {"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType", "kind" : "object"}, {"label" : "GroupErrorRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType", "kind" : "object"}, {"label" : "OutputRedirectionType", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirectionType", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionType[R]extendsAnyRef", "kind" : "trait"}, {"label" : "InputStream", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputStream", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputStreamextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputFileextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdIn", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdIn", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdInextendsRedirectionModule.this.InputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "InputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.InputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#InputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "AllCapturedToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedToSinkextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllCapturedThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllCapturedThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllCapturedThroughPipe[O,OR]extendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToFileextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "AllToStdErr", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.AllToStdErr", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#AllToStdErrextendsRedirectionModule.this.GroupErrorRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "GroupErrorRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.GroupErrorRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#GroupErrorRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "OutputStreamToSink", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamToSink", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamToSinkextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputStreamThroughPipe", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputStreamThroughPipe", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputStreamThroughPipe[O,OR]extendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputFile", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputFile", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputFileextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "StdOut", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.StdOut", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#StdOutextendsRedirectionModule.this.OutputRedirectionwithProductwithSerializable", "kind" : "case class"}, {"label" : "OutputRedirection", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.OutputRedirection", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#OutputRedirectionextendsAnyRef", "kind" : "sealed trait"}, {"label" : "RedirectableInput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableInput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableInput[+P<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors", "kind" : "object"}, {"label" : "RedirectableErrors", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableErrors", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableErrors[+P[_]<:RedirectionModule.this.ProcessGroup[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableError", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableError", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableError[+P[_]<:RedirectionModule.this.Process[_,_]]extendsAnyRef", "kind" : "trait"}, {"label" : "RedirectableOutput", "tail" : "", "member" : "io.github.vigoo.prox.RedirectionModule.RedirectableOutput", "link" : "io\/github\/vigoo\/prox\/RedirectionModule.html#RedirectableOutput[+P[_]<:io.github.vigoo.prox.ProcessLike]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup", "kind" : "object"}, {"label" : "ProcessGroupConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupConfiguration[O,E]extendsProcessGroupModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "ProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroup[O,E]extendsProcessLikewithProcessGroupModule.this.ProcessGroupConfiguration[O,E]", "kind" : "trait"}, {"label" : "RunningProcessGroup", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.RunningProcessGroup", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#RunningProcessGroup[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.SimpleProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#SimpleProcessGroupResult[+O,+E]extendsProcessGroupModule.this.ProcessGroupResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessGroupResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessGroupModule.ProcessGroupResult", "link" : "io\/github\/vigoo\/prox\/ProcessGroupModule.html#ProcessGroupResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process", "kind" : "object"}, {"label" : "ProcessConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessConfiguration", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessConfigurationextendsProcessModule.this.ProcessLikeConfiguration", "kind" : "trait"}, {"label" : "Process", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.Process", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#Process[O,E]extendsProcessLikewithProcessModule.this.ProcessConfiguration", "kind" : "trait"}, {"label" : "RunningProcess", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.RunningProcess", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#RunningProcess[O,E,+Info]extendsAnyRef", "kind" : "trait"}, {"label" : "SimpleProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.SimpleProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#SimpleProcessResult[+O,+E]extendsProcessModule.this.ProcessResult[O,E]withProductwithSerializable", "kind" : "case class"}, {"label" : "ProcessResult", "tail" : "", "member" : "io.github.vigoo.prox.ProcessModule.ProcessResult", "link" : "io\/github\/vigoo\/prox\/ProcessModule.html#ProcessResult[+O,+E]extendsAnyRef", "kind" : "trait"}, {"label" : "ProcessLikeConfiguration", "tail" : "", "member" : "io.github.vigoo.prox.CommonModule.ProcessLikeConfiguration", "link" : "io\/github\/vigoo\/prox\/CommonModule.html#ProcessLikeConfigurationextendsAnyRef", "kind" : "trait"}, {"label" : "ListProxErrorOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ListProxErrorOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ListProxErrorOpsextendsAnyRef", "kind" : "implicit class"}, {"label" : "MonoidStreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.MonoidStreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#MonoidStreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "StreamOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.StreamOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#StreamOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "FiberOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.FiberOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#FiberOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "ResourceOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.ResourceOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#ResourceOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "IOOps", "tail" : "", "member" : "io.github.vigoo.prox.ProxRuntime.IOOps", "link" : "io\/github\/vigoo\/prox\/ProxRuntime.html#IOOps[A]extendsAnyRef", "kind" : "implicit class"}, {"label" : "sinkAsTransformAndSink", "tail" : "(sink: ZSink[Any, ProxError, A, Any, Unit]): TransformAndSink[A, A]", "member" : "io.github.vigoo.prox.ProxZStream.sinkAsTransformAndSink", "link" : "io\/github\/vigoo\/prox\/zstream$.html#sinkAsTransformAndSink[A](sink:zio.stream.ZSink[Any,io.github.vigoo.prox.ProxError,A,Any,Unit]):ProxZStream.this.TransformAndSink[A,A]", "kind" : "implicit def"}, {"label" : "transducerAsPipeThrowable", "tail" : "(transducer: ZPipeline[Any, Throwable, A, B]): ProxPipe[A, B]", "member" : "io.github.vigoo.prox.ProxZStream.transducerAsPipeThrowable", "link" : "io\/github\/vigoo\/prox\/zstream$.html#transducerAsPipeThrowable[A,B](transducer:zio.stream.ZPipeline[Any,Throwable,A,B]):ProxZStream.this.ProxPipe[A,B]", "kind" : "implicit def"}, {"label" : "transducerAsPipe", "tail" : "(transducer: ZPipeline[Any, ProxError, A, B]): ProxPipe[A, B]", "member" : "io.github.vigoo.prox.ProxZStream.transducerAsPipe", "link" : "io\/github\/vigoo\/prox\/zstream$.html#transducerAsPipe[A,B](transducer:zio.stream.ZPipeline[Any,io.github.vigoo.prox.ProxError,A,B]):ProxZStream.this.ProxPipe[A,B]", "kind" : "implicit def"}, {"label" : "startFiber", "tail" : "(f: ProxIO[A]): ProxIO[ProxFiber[A]]", "member" : "io.github.vigoo.prox.ProxZStream.startFiber", "link" : "io\/github\/vigoo\/prox\/zstream$.html#startFiber[A](f:ProxZStream.this.ProxIO[A]):ProxZStream.this.ProxIO[ProxZStream.this.ProxFiber[A]]", "kind" : "final def"}, {"label" : "drainToJavaOutputStream", "tail" : "(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.drainToJavaOutputStream", "link" : "io\/github\/vigoo\/prox\/zstream$.html#drainToJavaOutputStream(stream:ProxZStream.this.ProxStream[Byte],output:java.io.OutputStream,flushChunks:Boolean):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "fromJavaInputStream", "tail" : "(input: java.io.InputStream, chunkSize: Int): ProxStream[Byte]", "member" : "io.github.vigoo.prox.ProxZStream.fromJavaInputStream", "link" : "io\/github\/vigoo\/prox\/zstream$.html#fromJavaInputStream(input:java.io.InputStream,chunkSize:Int):ProxZStream.this.ProxStream[Byte]", "kind" : "final def"}, {"label" : "runStreamTo", "tail" : "(s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.runStreamTo", "link" : "io\/github\/vigoo\/prox\/zstream$.html#runStreamTo[A](s:ProxZStream.this.ProxStream[A],sink:ProxZStream.this.ProxSink[A]):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "streamThrough", "tail" : "(s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]", "member" : "io.github.vigoo.prox.ProxZStream.streamThrough", "link" : "io\/github\/vigoo\/prox\/zstream$.html#streamThrough[A,B](s:ProxZStream.this.ProxStream[A],pipe:ProxZStream.this.ProxPipe[A,B]):ProxZStream.this.ProxStream[B]", "kind" : "final def"}, {"label" : "foldMonoidStream", "tail" : "(s: ProxStream[A])(arg0: Identity[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.foldMonoidStream", "link" : "io\/github\/vigoo\/prox\/zstream$.html#foldMonoidStream[A](s:ProxZStream.this.ProxStream[A])(implicitevidence$1:zio.prelude.Identity[A]):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "foldStream", "tail" : "(s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.foldStream", "link" : "io\/github\/vigoo\/prox\/zstream$.html#foldStream[A,B](s:ProxZStream.this.ProxStream[A],init:B,f:(B,A)=>B):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "streamToVector", "tail" : "(s: ProxStream[A]): ProxIO[Vector[A]]", "member" : "io.github.vigoo.prox.ProxZStream.streamToVector", "link" : "io\/github\/vigoo\/prox\/zstream$.html#streamToVector[A](s:ProxZStream.this.ProxStream[A]):ProxZStream.this.ProxIO[Vector[A]]", "kind" : "final def"}, {"label" : "drainStream", "tail" : "(s: ProxStream[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.drainStream", "link" : "io\/github\/vigoo\/prox\/zstream$.html#drainStream[A](s:ProxZStream.this.ProxStream[A]):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "cancelFiber", "tail" : "(f: ProxFiber[A]): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.cancelFiber", "link" : "io\/github\/vigoo\/prox\/zstream$.html#cancelFiber[A](f:ProxZStream.this.ProxFiber[A]):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "joinFiber", "tail" : "(f: ProxFiber[A]): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.joinFiber", "link" : "io\/github\/vigoo\/prox\/zstream$.html#joinFiber[A](f:ProxZStream.this.ProxFiber[A]):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "useResource", "tail" : "(r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.useResource", "link" : "io\/github\/vigoo\/prox\/zstream$.html#useResource[A,B](r:ProxZStream.this.ProxResource[A],f:A=>ProxZStream.this.ProxIO[B]):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "makeResource", "tail" : "(acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]", "member" : "io.github.vigoo.prox.ProxZStream.makeResource", "link" : "io\/github\/vigoo\/prox\/zstream$.html#makeResource[A](acquire:ProxZStream.this.ProxIO[A],release:A=>ProxZStream.this.ProxIO[Unit]):ProxZStream.this.ProxResource[A]", "kind" : "final def"}, {"label" : "bracket", "tail" : "(acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.bracket", "link" : "io\/github\/vigoo\/prox\/zstream$.html#bracket[A,B](acquire:ProxZStream.this.ProxIO[A])(use:A=>ProxZStream.this.ProxIO[B])(fin:(A,io.github.vigoo.prox.IOResult)=>ProxZStream.this.ProxIO[Unit]):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "identityPipe", "tail" : "(): ProxPipe[A, A]", "member" : "io.github.vigoo.prox.ProxZStream.identityPipe", "link" : "io\/github\/vigoo\/prox\/zstream$.html#identityPipe[A]:ProxZStream.this.ProxPipe[A,A]", "kind" : "final def"}, {"label" : "traverse", "tail" : "(list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]", "member" : "io.github.vigoo.prox.ProxZStream.traverse", "link" : "io\/github\/vigoo\/prox\/zstream$.html#traverse[A,B](list:List[A])(f:A=>ProxZStream.this.ProxIO[B]):ProxZStream.this.ProxIO[List[B]]", "kind" : "final def"}, {"label" : "ioFlatMap", "tail" : "(io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.ioFlatMap", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ioFlatMap[A,B](io:ProxZStream.this.ProxIO[A],f:A=>ProxZStream.this.ProxIO[B]):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "ioMap", "tail" : "(io: ProxIO[A], f: (A) => B): ProxIO[B]", "member" : "io.github.vigoo.prox.ProxZStream.ioMap", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ioMap[A,B](io:ProxZStream.this.ProxIO[A],f:A=>B):ProxZStream.this.ProxIO[B]", "kind" : "final def"}, {"label" : "raiseError", "tail" : "(error: ProxError): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.raiseError", "link" : "io\/github\/vigoo\/prox\/zstream$.html#raiseError(error:io.github.vigoo.prox.ProxError):ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "blockingEffect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.blockingEffect", "link" : "io\/github\/vigoo\/prox\/zstream$.html#blockingEffect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "effect", "tail" : "(f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.effect", "link" : "io\/github\/vigoo\/prox\/zstream$.html#effect[A](f:=>A,wrapError:Throwable=>io.github.vigoo.prox.ProxError):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "pure", "tail" : "(value: A): ProxIO[A]", "member" : "io.github.vigoo.prox.ProxZStream.pure", "link" : "io\/github\/vigoo\/prox\/zstream$.html#pure[A](value:A):ProxZStream.this.ProxIO[A]", "kind" : "final def"}, {"label" : "unit", "tail" : "(): ProxIO[Unit]", "member" : "io.github.vigoo.prox.ProxZStream.unit", "link" : "io\/github\/vigoo\/prox\/zstream$.html#unit:ProxZStream.this.ProxIO[Unit]", "kind" : "final def"}, {"label" : "exitCodeFromInt", "tail" : "(value: Int): ProxExitCode", "member" : "io.github.vigoo.prox.ProxZStream.exitCodeFromInt", "link" : "io\/github\/vigoo\/prox\/zstream$.html#exitCodeFromInt(value:Int):ProxZStream.this.ProxExitCode", "kind" : "final def"}, {"label" : "ProxMonoid", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxMonoid", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ProxMonoid[A]=zio.prelude.Identity[A]", "kind" : "type"}, {"label" : "ProxSink", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxSink", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ProxSink[A]=ProxZStream.this.TransformAndSink[A,_]", "kind" : "type"}, {"label" : "ProxPipe", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxPipe", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ProxPipe[A,B]=ProxZStream.this.ProxStream[A]=>ProxZStream.this.ProxStream[B]", "kind" : "type"}, {"label" : "ProxStream", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxStream", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ProxStream[A]=zio.stream.ZStream[Any,io.github.vigoo.prox.ProxError,A]", "kind" : "type"}, {"label" : "ProxResource", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxResource", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ProxResource[A]=zio.ZIO[zio.Scope,io.github.vigoo.prox.ProxError,A]", "kind" : "type"}, {"label" : "ProxIO", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxIO", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ProxIO[A]=zio.ZIO[Any,io.github.vigoo.prox.ProxError,A]", "kind" : "type"}, {"label" : "ProxFiber", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxFiber", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ProxFiber[A]=zio.Fiber[io.github.vigoo.prox.ProxError,A]", "kind" : "type"}, {"label" : "ProxExitCode", "tail" : "", "member" : "io.github.vigoo.prox.ProxZStream.ProxExitCode", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ProxExitCode=zio.ExitCode", "kind" : "type"}, {"label" : "synchronized", "tail" : "(arg0: => T0): T0", "member" : "scala.AnyRef.synchronized", "link" : "io\/github\/vigoo\/prox\/zstream$.html#synchronized[T0](x$1:=>T0):T0", "kind" : "final def"}, {"label" : "##", "tail" : "(): Int", "member" : "scala.AnyRef.##", "link" : "io\/github\/vigoo\/prox\/zstream$.html###:Int", "kind" : "final def"}, {"label" : "!=", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.!=", "link" : "io\/github\/vigoo\/prox\/zstream$.html#!=(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "==", "tail" : "(arg0: Any): Boolean", "member" : "scala.AnyRef.==", "link" : "io\/github\/vigoo\/prox\/zstream$.html#==(x$1:Any):Boolean", "kind" : "final def"}, {"label" : "ne", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.ne", "link" : "io\/github\/vigoo\/prox\/zstream$.html#ne(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "eq", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.eq", "link" : "io\/github\/vigoo\/prox\/zstream$.html#eq(x$1:AnyRef):Boolean", "kind" : "final def"}, {"label" : "finalize", "tail" : "(): Unit", "member" : "scala.AnyRef.finalize", "link" : "io\/github\/vigoo\/prox\/zstream$.html#finalize():Unit", "kind" : "def"}, {"label" : "notifyAll", "tail" : "(): Unit", "member" : "scala.AnyRef.notifyAll", "link" : "io\/github\/vigoo\/prox\/zstream$.html#notifyAll():Unit", "kind" : "final def"}, {"label" : "notify", "tail" : "(): Unit", "member" : "scala.AnyRef.notify", "link" : "io\/github\/vigoo\/prox\/zstream$.html#notify():Unit", "kind" : "final def"}, {"label" : "clone", "tail" : "(): AnyRef", "member" : "scala.AnyRef.clone", "link" : "io\/github\/vigoo\/prox\/zstream$.html#clone():Object", "kind" : "def"}, {"label" : "hashCode", "tail" : "(): Int", "member" : "scala.AnyRef.hashCode", "link" : "io\/github\/vigoo\/prox\/zstream$.html#hashCode():Int", "kind" : "def"}, {"label" : "getClass", "tail" : "(): Class[_ <: AnyRef]", "member" : "scala.AnyRef.getClass", "link" : "io\/github\/vigoo\/prox\/zstream$.html#getClass():Class[_]", "kind" : "final def"}, {"label" : "wait", "tail" : "(): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/zstream$.html#wait():Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long, arg1: Int): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/zstream$.html#wait(x$1:Long,x$2:Int):Unit", "kind" : "final def"}, {"label" : "wait", "tail" : "(arg0: Long): Unit", "member" : "scala.AnyRef.wait", "link" : "io\/github\/vigoo\/prox\/zstream$.html#wait(x$1:Long):Unit", "kind" : "final def"}, {"label" : "toString", "tail" : "(): String", "member" : "scala.AnyRef.toString", "link" : "io\/github\/vigoo\/prox\/zstream$.html#toString():String", "kind" : "def"}, {"label" : "equals", "tail" : "(arg0: AnyRef): Boolean", "member" : "scala.AnyRef.equals", "link" : "io\/github\/vigoo\/prox\/zstream$.html#equals(x$1:Object):Boolean", "kind" : "def"}, {"label" : "asInstanceOf", "tail" : "(): T0", "member" : "scala.Any.asInstanceOf", "link" : "io\/github\/vigoo\/prox\/zstream$.html#asInstanceOf[T0]:T0", "kind" : "final def"}, {"label" : "isInstanceOf", "tail" : "(): Boolean", "member" : "scala.Any.isInstanceOf", "link" : "io\/github\/vigoo\/prox\/zstream$.html#isInstanceOf[T0]:Boolean", "kind" : "final def"}], "kind" : "object"}], "io.github" : [], "zio.prelude" : [], "io" : [], "io.github.vigoo" : []}; \ No newline at end of file diff --git a/api/io/github/index.html b/api/io/github/index.html new file mode 100644 index 00000000..30cbe982 --- /dev/null +++ b/api/io/github/index.html @@ -0,0 +1,2 @@ +

Packages

p

io

github

package github

Package Members

  1. package vigoo

Ungrouped

diff --git a/api/io/github/vigoo/index.html b/api/io/github/vigoo/index.html new file mode 100644 index 00000000..9d8e3ba6 --- /dev/null +++ b/api/io/github/vigoo/index.html @@ -0,0 +1,18 @@ +

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

package vigoo

Package Members

  1. 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. +

Ungrouped

diff --git a/api/io/github/vigoo/prox/CommonModule$ProcessLikeConfiguration.html b/api/io/github/vigoo/prox/CommonModule$ProcessLikeConfiguration.html new file mode 100644 index 00000000..89e16b68 --- /dev/null +++ b/api/io/github/vigoo/prox/CommonModule$ProcessLikeConfiguration.html @@ -0,0 +1,26 @@ +

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 CommonModule extends AnyRef
    Definition Classes
    prox
  • ProcessLikeConfiguration
t

io.github.vigoo.prox.CommonModule

ProcessLikeConfiguration

trait ProcessLikeConfiguration extends AnyRef

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessLikeConfiguration
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Self <: Prox.ProcessLikeConfiguration

Abstract Value Members

  1. abstract def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
  2. abstract val environmentVariables: Map[String, String]
  3. abstract val removedEnvironmentVariables: Set[String]
  4. abstract val workingDirectory: Option[Path]

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. 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

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

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. 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

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

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/CommonModule.html b/api/io/github/vigoo/prox/CommonModule.html new file mode 100644 index 00000000..8802200f --- /dev/null +++ b/api/io/github/vigoo/prox/CommonModule.html @@ -0,0 +1,10 @@ +

Packages

t

io.github.vigoo.prox

CommonModule

trait CommonModule extends AnyRef

Self Type
Prox
Linear Supertypes
AnyRef, Any
Known Subclasses
Prox, ProxFS2, ProxZStream, zstream
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommonModule
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait ProcessLikeConfiguration extends AnyRef

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToDestroy.html b/api/io/github/vigoo/prox/FailedToDestroy.html new file mode 100644 index 00000000..b0c38d3b --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToDestroy.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToDestroy

final case class FailedToDestroy(reason: Throwable) extends ProxError with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, ProxError, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToDestroy
  2. Serializable
  3. Product
  4. Equals
  5. ProxError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToDestroy(reason: Throwable)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. val reason: Throwable
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toThrowable: Throwable
    Definition Classes
    FailedToDestroy → ProxError
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProxError

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToDestroyException.html b/api/io/github/vigoo/prox/FailedToDestroyException.html new file mode 100644 index 00000000..a5dc5c9a --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToDestroyException.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToDestroyException

final case class FailedToDestroyException(reason: Throwable) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToDestroyException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToDestroyException(reason: Throwable)

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. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  9. def getCause(): Throwable
    Definition Classes
    Throwable
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  12. def getMessage(): String
    Definition Classes
    Throwable
  13. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  14. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  15. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  21. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(): Unit
    Definition Classes
    Throwable
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val reason: Throwable
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToQueryState.html b/api/io/github/vigoo/prox/FailedToQueryState.html new file mode 100644 index 00000000..230fcce3 --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToQueryState.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToQueryState

final case class FailedToQueryState(reason: Throwable) extends ProxError with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, ProxError, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToQueryState
  2. Serializable
  3. Product
  4. Equals
  5. ProxError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToQueryState(reason: Throwable)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. val reason: Throwable
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toThrowable: Throwable
    Definition Classes
    FailedToQueryState → ProxError
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProxError

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToQueryStateException.html b/api/io/github/vigoo/prox/FailedToQueryStateException.html new file mode 100644 index 00000000..a45d26ec --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToQueryStateException.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToQueryStateException

final case class FailedToQueryStateException(reason: Throwable) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToQueryStateException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToQueryStateException(reason: Throwable)

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. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  9. def getCause(): Throwable
    Definition Classes
    Throwable
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  12. def getMessage(): String
    Definition Classes
    Throwable
  13. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  14. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  15. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  21. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(): Unit
    Definition Classes
    Throwable
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val reason: Throwable
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToReadProcessOutput.html b/api/io/github/vigoo/prox/FailedToReadProcessOutput.html new file mode 100644 index 00000000..42fed9f2 --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToReadProcessOutput.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToReadProcessOutput

final case class FailedToReadProcessOutput(reason: Throwable) extends ProxError with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, ProxError, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToReadProcessOutput
  2. Serializable
  3. Product
  4. Equals
  5. ProxError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToReadProcessOutput(reason: Throwable)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. val reason: Throwable
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toThrowable: Throwable
    Definition Classes
    FailedToReadProcessOutput → ProxError
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProxError

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToReadProcessOutputException.html b/api/io/github/vigoo/prox/FailedToReadProcessOutputException.html new file mode 100644 index 00000000..60cddf97 --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToReadProcessOutputException.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToReadProcessOutputException

final case class FailedToReadProcessOutputException(reason: Throwable) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToReadProcessOutputException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToReadProcessOutputException(reason: Throwable)

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. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  9. def getCause(): Throwable
    Definition Classes
    Throwable
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  12. def getMessage(): String
    Definition Classes
    Throwable
  13. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  14. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  15. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  21. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(): Unit
    Definition Classes
    Throwable
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val reason: Throwable
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToStartProcess.html b/api/io/github/vigoo/prox/FailedToStartProcess.html new file mode 100644 index 00000000..8c8fab1b --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToStartProcess.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToStartProcess

final case class FailedToStartProcess(reason: Throwable) extends ProxError with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, ProxError, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToStartProcess
  2. Serializable
  3. Product
  4. Equals
  5. ProxError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToStartProcess(reason: Throwable)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. val reason: Throwable
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toThrowable: Throwable
    Definition Classes
    FailedToStartProcess → ProxError
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProxError

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToStartProcessException.html b/api/io/github/vigoo/prox/FailedToStartProcessException.html new file mode 100644 index 00000000..bf0d9b89 --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToStartProcessException.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToStartProcessException

final case class FailedToStartProcessException(reason: Throwable) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToStartProcessException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToStartProcessException(reason: Throwable)

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. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  9. def getCause(): Throwable
    Definition Classes
    Throwable
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  12. def getMessage(): String
    Definition Classes
    Throwable
  13. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  14. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  15. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  21. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(): Unit
    Definition Classes
    Throwable
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val reason: Throwable
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToWaitForExit.html b/api/io/github/vigoo/prox/FailedToWaitForExit.html new file mode 100644 index 00000000..9d09e63c --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToWaitForExit.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToWaitForExit

final case class FailedToWaitForExit(reason: Throwable) extends ProxError with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, ProxError, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToWaitForExit
  2. Serializable
  3. Product
  4. Equals
  5. ProxError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToWaitForExit(reason: Throwable)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. val reason: Throwable
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toThrowable: Throwable
    Definition Classes
    FailedToWaitForExit → ProxError
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProxError

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToWaitForExitException.html b/api/io/github/vigoo/prox/FailedToWaitForExitException.html new file mode 100644 index 00000000..497c54e5 --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToWaitForExitException.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToWaitForExitException

final case class FailedToWaitForExitException(reason: Throwable) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToWaitForExitException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToWaitForExitException(reason: Throwable)

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. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  9. def getCause(): Throwable
    Definition Classes
    Throwable
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  12. def getMessage(): String
    Definition Classes
    Throwable
  13. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  14. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  15. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  21. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(): Unit
    Definition Classes
    Throwable
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val reason: Throwable
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToWriteProcessInput.html b/api/io/github/vigoo/prox/FailedToWriteProcessInput.html new file mode 100644 index 00000000..4f742b14 --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToWriteProcessInput.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToWriteProcessInput

final case class FailedToWriteProcessInput(reason: Throwable) extends ProxError with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, ProxError, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToWriteProcessInput
  2. Serializable
  3. Product
  4. Equals
  5. ProxError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToWriteProcessInput(reason: Throwable)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. val reason: Throwable
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toThrowable: Throwable
    Definition Classes
    FailedToWriteProcessInput → ProxError
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProxError

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/FailedToWriteProcessInputException.html b/api/io/github/vigoo/prox/FailedToWriteProcessInputException.html new file mode 100644 index 00000000..77e335b7 --- /dev/null +++ b/api/io/github/vigoo/prox/FailedToWriteProcessInputException.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

FailedToWriteProcessInputException

final case class FailedToWriteProcessInputException(reason: Throwable) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailedToWriteProcessInputException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FailedToWriteProcessInputException(reason: Throwable)

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. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  9. def getCause(): Throwable
    Definition Classes
    Throwable
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  12. def getMessage(): String
    Definition Classes
    Throwable
  13. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  14. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  15. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  21. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(): Unit
    Definition Classes
    Throwable
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val reason: Throwable
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/MultipleProxErrors.html b/api/io/github/vigoo/prox/MultipleProxErrors.html new file mode 100644 index 00000000..4b31b212 --- /dev/null +++ b/api/io/github/vigoo/prox/MultipleProxErrors.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

MultipleProxErrors

final case class MultipleProxErrors(errors: List[ProxError]) extends ProxError with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, ProxError, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MultipleProxErrors
  2. Serializable
  3. Product
  4. Equals
  5. ProxError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MultipleProxErrors(errors: List[ProxError])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val errors: List[ProxError]
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toThrowable: Throwable
    Definition Classes
    MultipleProxErrors → ProxError
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProxError

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/MultipleProxErrorsException.html b/api/io/github/vigoo/prox/MultipleProxErrorsException.html new file mode 100644 index 00000000..e80d91bc --- /dev/null +++ b/api/io/github/vigoo/prox/MultipleProxErrorsException.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

MultipleProxErrorsException

final case class MultipleProxErrorsException(value: List[ProxError]) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MultipleProxErrorsException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MultipleProxErrorsException(value: List[ProxError])

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. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  9. def getCause(): Throwable
    Definition Classes
    Throwable
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  12. def getMessage(): String
    Definition Classes
    Throwable
  13. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  14. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  15. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  21. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(): Unit
    Definition Classes
    Throwable
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  27. val value: List[ProxError]
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$Mapper.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$Mapper.html new file mode 100644 index 00000000..d4f5d024 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$Mapper.html @@ -0,0 +1,10 @@ +

Packages

trait Mapper[O, E] extends AnyRef

Mapper functions for altering a process group

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

Abstract Value Members

  1. abstract def mapFirst[P <: Prox.Process[Prox.ProxStream[Byte], E]](process: P): P
  2. abstract def mapInnerWithIdx[P <: UnboundIProcess[Prox.ProxStream[Byte], E]](process: P, idx: Int): P
  3. abstract def mapLast[P <: UnboundIProcess[O, E]](process: P): P

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImpl.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImpl.html new file mode 100644 index 00000000..a4a51752 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImpl.html @@ -0,0 +1,224 @@ +

Packages

case class ProcessGroupImpl(firstProcess: UnboundIEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundProcess, originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[Unit, Unit] with Prox.RedirectableOutput[[α$6$]ProcessGroupImplO[α$6$]] with Prox.RedirectableInput[ProcessGroupImplI] with Prox.RedirectableErrors[[α$7$]ProcessGroupImplE[α$7$]] with Product with Serializable

Process group with unbound input, output and error streams

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableErrors[[α$7$]ProcessGroupImplE[α$7$]], Prox.RedirectableInput[ProcessGroupImplI], Prox.RedirectableOutput[[α$6$]ProcessGroupImplO[α$6$]], Prox.ProcessGroup[Unit, Unit], Prox.ProcessGroupConfiguration[Unit, Unit], Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupImpl
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableErrors
  6. RedirectableInput
  7. RedirectableOutput
  8. ProcessGroup
  9. ProcessGroupConfiguration
  10. ProcessLikeConfiguration
  11. ProcessLike
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessGroupImpl(firstProcess: UnboundIEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundProcess, originalProcesses: List[Prox.Process[Unit, Unit]])

Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): ProcessGroupImplI

    Feed the process input from a byte stream with flushing per chunks +enabled.

    Feed the process input from a byte stream with flushing per chunks +enabled.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. def !>(sink: Prox.ProxSink[Byte]): ProcessGroupImplE[Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

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

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

    Redirects the error outputs 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 errorsToFoldMonoid +

    O

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

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  5. def !>?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplE[Vector[O]]

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

    Redirects the error outputs 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 errorsToVector +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  6. final def ##: Int
    Definition Classes
    AnyRef → Any
  7. def <(stream: Prox.ProxStream[Byte]): ProcessGroupImplI

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  8. def <(path: Path): ProcessGroupImplI

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def >(path: Path): ProcessGroupImplO[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for toFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  11. def >(sink: Prox.ProxSink[Byte]): ProcessGroupImplO[Unit]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  12. def >#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplO[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 +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  13. def >>(path: Path): ProcessGroupImplO[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 +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  14. def >?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplO[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 +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  15. def appendToFile(path: Path): ProcessGroupImplO[Unit]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for >> +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  16. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. def connectErrors[R <: Prox.GroupErrorRedirection, OR <: Prox.OutputRedirection, E](target: R)(implicit groupErrorRedirectionType: Aux[R, OR, E], outputRedirectionType: Aux[OR, E]): ProcessGroupImplE[E]

    The low level operation to attach an error output to all the processes +in the group.

    The low level operation to attach an error output to all the processes +in the group.

    Use one of the other methods of this trait or the advanced interface +represented by customizedPerProcess for convenience.

    This is the place where the process group's error output type gets +calculated using the GroupErrorRedirectionType and +OutputRedirectionType type classes. +

    R

    + Error output grouped redirection type

    OR

    + Error output redirection type

    E

    + Error output type

    target

    + Redirection target

    groupErrorRedirectionType

    + Helper for dependent error output type

    outputRedirectionType

    + Helper for dependent error output type

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    ProcessGroupImpl → RedirectableErrors
  20. def connectInput(source: Prox.InputRedirection): ProcessGroupImplI

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience. +

    source

    + Redirection source

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    ProcessGroupImpl → RedirectableInput
  21. def connectOutput[R <: Prox.OutputRedirection, RO](target: R)(implicit outputRedirectionType: Aux[R, RO]): ProcessGroupImplO[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. +

    R

    + Output redirection type

    target

    + Redirection target

    outputRedirectionType

    + Helper for dependent output type

    returns

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

    Definition Classes
    ProcessGroupImpl → RedirectableOutput
  22. lazy val customizedPerProcess: CustomizedPerProcess[[α$7$]ProcessGroupImplE[α$7$]]

    A more advanced interface for customizing the redirection per process

    A more advanced interface for customizing the redirection per process

    Definition Classes
    RedirectableErrors
  23. def drainErrors[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplE[Unit]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  24. def drainOutput[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplO[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. +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  25. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def errorsToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplE[O]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  28. def errorsToSink(sink: Prox.ProxSink[Byte]): ProcessGroupImplE[Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  29. def errorsToVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplE[Vector[O]]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  30. val firstProcess: UnboundIEProcess[Prox.ProxStream[Byte]]
    Definition Classes
    ProcessGroupImpl → ProcessGroup
  31. def foldErrors[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplE[R]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  32. def foldOutput[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplO[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. +

    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 or process group with its output redirected and + its output redirection capability removed.

    Definition Classes
    RedirectableOutput
  33. def fromFile(path: Path): ProcessGroupImplI

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  34. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): ProcessGroupImplI

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<. +

    stream

    + Input stream

    flushChunks

    + Flush the process input stream after each chunk

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  35. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  36. 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
  37. 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
  38. val innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]]
    Definition Classes
    ProcessGroupImpl → ProcessGroup
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. val lastProcess: UnboundProcess
    Definition Classes
    ProcessGroupImpl → ProcessGroup
  41. def map(f: Mapper[Unit, Unit]): ProcessGroupImpl

    Applies the given mapper to each process in the group +

    Applies the given mapper to each process in the group +

    f

    + process mapper

    returns

    + a new process group with all the processes altered by the mapper

    Definition Classes
    ProcessGroupImpl → ProcessGroup
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  45. val originalProcesses: List[Prox.Process[Unit, Unit]]
    Definition Classes
    ProcessGroupImpl → ProcessGroup
  46. def pipeInto(other: UnboundProcess, channel: Prox.ProxPipe[Byte, Byte]): ProcessGroupImpl
  47. def productElementNames: Iterator[String]
    Definition Classes
    Product
  48. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  49. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessGroupResult[Unit, Unit]]

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

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

    runner

    + The process runner to be used

    returns

    + the result of the finished processes

    Definition Classes
    ProcessGroup
  50. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[Unit, Unit]]]

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Joining the fiber waits for the processes to be terminated. Canceling +the fiber terminates the processesnormally (with SIGTERM). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running processes

    Definition Classes
    ProcessGroup
  51. def startProcessGroup[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcessGroup[Unit, Unit, Info]]

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    This is the most advanced way to start process groups. See start and +run as alternatives. +

    Info

    + The runner-specific information about the started processes

    runner

    + The process runner to be used

    returns

    + interface for handling the running process group

    Definition Classes
    ProcessGroup
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. def toFile(path: Path): ProcessGroupImplO[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for > +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  54. def toFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplO[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 ># +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  55. def toSink(sink: Prox.ProxSink[Byte]): ProcessGroupImplO[Unit]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  56. def toVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplO[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 >? +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  57. def via(channel: Prox.ProxPipe[Byte, Byte]): Prox.PipeBuilderSyntax[ProcessGroupImpl]
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  61. 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
  62. 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
  63. val workingDirectory: Option[Path]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  64. def |(other: UnboundProcess): ProcessGroupImpl
  65. object ConfigApplication
    Definition Classes
    ProcessGroupConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableErrors[[α$7$]ProcessGroupImplE[α$7$]]

Inherited from Prox.RedirectableInput[ProcessGroupImplI]

Inherited from Prox.RedirectableOutput[[α$6$]ProcessGroupImplO[α$6$]]

Inherited from Prox.ProcessGroup[Unit, Unit]

Inherited from Prox.ProcessGroupConfiguration[Unit, Unit]

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplE.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplE.html new file mode 100644 index 00000000..e8277d7d --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplE.html @@ -0,0 +1,152 @@ +

Packages

case class ProcessGroupImplE[E](firstProcess: UnboundIProcess[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIOProcess[E], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[Unit, E] with Prox.RedirectableOutput[[α$5$]ProcessGroupImplOE[α$5$, E]] with Prox.RedirectableInput[ProcessGroupImplIE[E]] with Product with Serializable

Process group with bound error stream

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableInput[ProcessGroupImplIE[E]], Prox.RedirectableOutput[[α$5$]ProcessGroupImplOE[α$5$, E]], Prox.ProcessGroup[Unit, E], Prox.ProcessGroupConfiguration[Unit, E], Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupImplE
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableInput
  6. RedirectableOutput
  7. ProcessGroup
  8. ProcessGroupConfiguration
  9. ProcessLikeConfiguration
  10. ProcessLike
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessGroupImplE(firstProcess: UnboundIProcess[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIOProcess[E], originalProcesses: List[Prox.Process[Unit, Unit]])

Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): ProcessGroupImplIE[E]

    Feed the process input from a byte stream with flushing per chunks +enabled.

    Feed the process input from a byte stream with flushing per chunks +enabled.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. def <(stream: Prox.ProxStream[Byte]): ProcessGroupImplIE[E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  5. def <(path: Path): ProcessGroupImplIE[E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def >(path: Path): ProcessGroupImplOE[Unit, E]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for toFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  8. def >(sink: Prox.ProxSink[Byte]): ProcessGroupImplOE[Unit, E]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  9. def >#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplOE[O, E]

    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 +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  10. def >>(path: Path): ProcessGroupImplOE[Unit, E]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for appendToFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  11. def >?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplOE[Vector[O], E]

    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 +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  12. def appendToFile(path: Path): ProcessGroupImplOE[Unit, E]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for >> +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  13. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. def connectInput(source: Prox.InputRedirection): ProcessGroupImplIE[E]

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience. +

    source

    + Redirection source

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    ProcessGroupImplE → RedirectableInput
  17. def connectOutput[R <: Prox.OutputRedirection, RO](target: R)(implicit outputRedirectionType: Aux[R, RO]): ProcessGroupImplOE[RO, E]

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

    R

    + Output redirection type

    target

    + Redirection target

    outputRedirectionType

    + Helper for dependent output type

    returns

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

    Definition Classes
    ProcessGroupImplE → RedirectableOutput
  18. def drainOutput[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplOE[Unit, E]

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

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  19. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. val firstProcess: UnboundIProcess[Prox.ProxStream[Byte], E]
    Definition Classes
    ProcessGroupImplE → ProcessGroup
  22. def foldOutput[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplOE[R, E]

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

    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 or process group with its output redirected and + its output redirection capability removed.

    Definition Classes
    RedirectableOutput
  23. def fromFile(path: Path): ProcessGroupImplIE[E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  24. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): ProcessGroupImplIE[E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<. +

    stream

    + Input stream

    flushChunks

    + Flush the process input stream after each chunk

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  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 innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]]
    Definition Classes
    ProcessGroupImplE → ProcessGroup
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. val lastProcess: UnboundIOProcess[E]
    Definition Classes
    ProcessGroupImplE → ProcessGroup
  31. def map(f: Mapper[Unit, E]): ProcessGroupImplE[E]

    Applies the given mapper to each process in the group +

    Applies the given mapper to each process in the group +

    f

    + process mapper

    returns

    + a new process group with all the processes altered by the mapper

    Definition Classes
    ProcessGroupImplE → ProcessGroup
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  35. val originalProcesses: List[Prox.Process[Unit, Unit]]
    Definition Classes
    ProcessGroupImplE → ProcessGroup
  36. def productElementNames: Iterator[String]
    Definition Classes
    Product
  37. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  38. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessGroupResult[Unit, E]]

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

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

    runner

    + The process runner to be used

    returns

    + the result of the finished processes

    Definition Classes
    ProcessGroup
  39. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[Unit, E]]]

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Joining the fiber waits for the processes to be terminated. Canceling +the fiber terminates the processesnormally (with SIGTERM). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running processes

    Definition Classes
    ProcessGroup
  40. def startProcessGroup[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcessGroup[Unit, E, Info]]

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    This is the most advanced way to start process groups. See start and +run as alternatives. +

    Info

    + The runner-specific information about the started processes

    runner

    + The process runner to be used

    returns

    + interface for handling the running process group

    Definition Classes
    ProcessGroup
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def toFile(path: Path): ProcessGroupImplOE[Unit, E]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for > +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  43. def toFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplOE[O, E]

    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 ># +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  44. def toSink(sink: Prox.ProxSink[Byte]): ProcessGroupImplOE[Unit, E]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  45. def toVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplOE[Vector[O], E]

    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 >? +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. 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
  50. 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
  51. val workingDirectory: Option[Path]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  52. object ConfigApplication
    Definition Classes
    ProcessGroupConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableInput[ProcessGroupImplIE[E]]

Inherited from Prox.RedirectableOutput[[α$5$]ProcessGroupImplOE[α$5$, E]]

Inherited from Prox.ProcessGroup[Unit, E]

Inherited from Prox.ProcessGroupConfiguration[Unit, E]

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplI.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplI.html new file mode 100644 index 00000000..8a091402 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplI.html @@ -0,0 +1,197 @@ +

Packages

case class ProcessGroupImplI(firstProcess: UnboundEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundProcess, originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[Unit, Unit] with Prox.RedirectableOutput[[α$2$]ProcessGroupImplIO[α$2$]] with Prox.RedirectableErrors[[α$3$]ProcessGroupImplIE[α$3$]] with Product with Serializable

Process group with bound input stream

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableErrors[[α$3$]ProcessGroupImplIE[α$3$]], Prox.RedirectableOutput[[α$2$]ProcessGroupImplIO[α$2$]], Prox.ProcessGroup[Unit, Unit], Prox.ProcessGroupConfiguration[Unit, Unit], Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupImplI
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableErrors
  6. RedirectableOutput
  7. ProcessGroup
  8. ProcessGroupConfiguration
  9. ProcessLikeConfiguration
  10. ProcessLike
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessGroupImplI(firstProcess: UnboundEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundProcess, originalProcesses: List[Prox.Process[Unit, Unit]])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def !>(sink: Prox.ProxSink[Byte]): ProcessGroupImplIE[Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  3. def !>#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplIE[O]

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

    Redirects the error outputs 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 errorsToFoldMonoid +

    O

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

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  4. def !>?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIE[Vector[O]]

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

    Redirects the error outputs 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 errorsToVector +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def >(path: Path): ProcessGroupImplIO[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for toFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  8. def >(sink: Prox.ProxSink[Byte]): ProcessGroupImplIO[Unit]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  9. def >#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplIO[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 +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  10. def >>(path: Path): ProcessGroupImplIO[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 +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  11. def >?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIO[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 +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  12. def appendToFile(path: Path): ProcessGroupImplIO[Unit]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for >> +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  13. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. def connectErrors[R <: Prox.GroupErrorRedirection, OR <: Prox.OutputRedirection, E](target: R)(implicit groupErrorRedirectionType: Aux[R, OR, E], outputRedirectionType: Aux[OR, E]): ProcessGroupImplIE[E]

    The low level operation to attach an error output to all the processes +in the group.

    The low level operation to attach an error output to all the processes +in the group.

    Use one of the other methods of this trait or the advanced interface +represented by customizedPerProcess for convenience.

    This is the place where the process group's error output type gets +calculated using the GroupErrorRedirectionType and +OutputRedirectionType type classes. +

    R

    + Error output grouped redirection type

    OR

    + Error output redirection type

    E

    + Error output type

    target

    + Redirection target

    groupErrorRedirectionType

    + Helper for dependent error output type

    outputRedirectionType

    + Helper for dependent error output type

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    ProcessGroupImplI → RedirectableErrors
  17. def connectOutput[R <: Prox.OutputRedirection, RO](target: R)(implicit outputRedirectionType: Aux[R, RO]): ProcessGroupImplIO[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. +

    R

    + Output redirection type

    target

    + Redirection target

    outputRedirectionType

    + Helper for dependent output type

    returns

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

    Definition Classes
    ProcessGroupImplI → RedirectableOutput
  18. lazy val customizedPerProcess: CustomizedPerProcess[[α$3$]ProcessGroupImplIE[α$3$]]

    A more advanced interface for customizing the redirection per process

    A more advanced interface for customizing the redirection per process

    Definition Classes
    RedirectableErrors
  19. def drainErrors[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIE[Unit]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  20. def drainOutput[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIO[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. +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  21. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def errorsToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplIE[O]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  24. def errorsToSink(sink: Prox.ProxSink[Byte]): ProcessGroupImplIE[Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  25. def errorsToVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIE[Vector[O]]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  26. val firstProcess: UnboundEProcess[Prox.ProxStream[Byte]]
    Definition Classes
    ProcessGroupImplI → ProcessGroup
  27. def foldErrors[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplIE[R]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  28. def foldOutput[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplIO[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. +

    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 or process group with its output redirected and + its output redirection capability removed.

    Definition Classes
    RedirectableOutput
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  30. 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
  31. 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
  32. val innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]]
    Definition Classes
    ProcessGroupImplI → ProcessGroup
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. val lastProcess: UnboundProcess
    Definition Classes
    ProcessGroupImplI → ProcessGroup
  35. def map(f: Mapper[Unit, Unit]): ProcessGroupImplI

    Applies the given mapper to each process in the group +

    Applies the given mapper to each process in the group +

    f

    + process mapper

    returns

    + a new process group with all the processes altered by the mapper

    Definition Classes
    ProcessGroupImplI → ProcessGroup
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  39. val originalProcesses: List[Prox.Process[Unit, Unit]]
    Definition Classes
    ProcessGroupImplI → ProcessGroup
  40. def productElementNames: Iterator[String]
    Definition Classes
    Product
  41. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  42. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessGroupResult[Unit, Unit]]

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

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

    runner

    + The process runner to be used

    returns

    + the result of the finished processes

    Definition Classes
    ProcessGroup
  43. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[Unit, Unit]]]

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Joining the fiber waits for the processes to be terminated. Canceling +the fiber terminates the processesnormally (with SIGTERM). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running processes

    Definition Classes
    ProcessGroup
  44. def startProcessGroup[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcessGroup[Unit, Unit, Info]]

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    This is the most advanced way to start process groups. See start and +run as alternatives. +

    Info

    + The runner-specific information about the started processes

    runner

    + The process runner to be used

    returns

    + interface for handling the running process group

    Definition Classes
    ProcessGroup
  45. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  46. def toFile(path: Path): ProcessGroupImplIO[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for > +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  47. def toFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplIO[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 ># +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  48. def toSink(sink: Prox.ProxSink[Byte]): ProcessGroupImplIO[Unit]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  49. def toVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIO[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 >? +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  53. 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
  54. 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
  55. val workingDirectory: Option[Path]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  56. object ConfigApplication
    Definition Classes
    ProcessGroupConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableErrors[[α$3$]ProcessGroupImplIE[α$3$]]

Inherited from Prox.RedirectableOutput[[α$2$]ProcessGroupImplIO[α$2$]]

Inherited from Prox.ProcessGroup[Unit, Unit]

Inherited from Prox.ProcessGroupConfiguration[Unit, Unit]

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplIE.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplIE.html new file mode 100644 index 00000000..6b8b270a --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplIE.html @@ -0,0 +1,125 @@ +

Packages

case class ProcessGroupImplIE[E](firstProcess: Prox.Process[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIOProcess[E], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[Unit, E] with Prox.RedirectableOutput[[α$1$]ProcessGroupImplIOE[α$1$, E]] with Product with Serializable

Process group with bound input and error streams

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableOutput[[α$1$]ProcessGroupImplIOE[α$1$, E]], Prox.ProcessGroup[Unit, E], Prox.ProcessGroupConfiguration[Unit, E], Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupImplIE
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableOutput
  6. ProcessGroup
  7. ProcessGroupConfiguration
  8. ProcessLikeConfiguration
  9. ProcessLike
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessGroupImplIE(firstProcess: Prox.Process[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIOProcess[E], originalProcesses: List[Prox.Process[Unit, Unit]])

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 >(path: Path): ProcessGroupImplIOE[Unit, E]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for toFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  5. def >(sink: Prox.ProxSink[Byte]): ProcessGroupImplIOE[Unit, E]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  6. def >#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplIOE[O, E]

    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 +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  7. def >>(path: Path): ProcessGroupImplIOE[Unit, E]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for appendToFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  8. def >?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIOE[Vector[O], E]

    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 +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  9. def appendToFile(path: Path): ProcessGroupImplIOE[Unit, E]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for >> +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  10. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. def connectOutput[R <: Prox.OutputRedirection, RO](target: R)(implicit outputRedirectionType: Aux[R, RO]): ProcessGroupImplIOE[RO, E]

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

    R

    + Output redirection type

    target

    + Redirection target

    outputRedirectionType

    + Helper for dependent output type

    returns

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

    Definition Classes
    ProcessGroupImplIE → RedirectableOutput
  14. def drainOutput[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIOE[Unit, E]

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

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  15. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. val firstProcess: Prox.Process[Prox.ProxStream[Byte], E]
    Definition Classes
    ProcessGroupImplIE → ProcessGroup
  18. def foldOutput[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplIOE[R, E]

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

    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 or process group with its output redirected and + its output redirection capability removed.

    Definition Classes
    RedirectableOutput
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. 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
  21. 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
  22. val innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]]
    Definition Classes
    ProcessGroupImplIE → ProcessGroup
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val lastProcess: UnboundIOProcess[E]
    Definition Classes
    ProcessGroupImplIE → ProcessGroup
  25. def map(f: Mapper[Unit, E]): ProcessGroupImplIE[E]

    Applies the given mapper to each process in the group +

    Applies the given mapper to each process in the group +

    f

    + process mapper

    returns

    + a new process group with all the processes altered by the mapper

    Definition Classes
    ProcessGroupImplIE → ProcessGroup
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  29. val originalProcesses: List[Prox.Process[Unit, Unit]]
    Definition Classes
    ProcessGroupImplIE → ProcessGroup
  30. def productElementNames: Iterator[String]
    Definition Classes
    Product
  31. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  32. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessGroupResult[Unit, E]]

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

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

    runner

    + The process runner to be used

    returns

    + the result of the finished processes

    Definition Classes
    ProcessGroup
  33. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[Unit, E]]]

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Joining the fiber waits for the processes to be terminated. Canceling +the fiber terminates the processesnormally (with SIGTERM). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running processes

    Definition Classes
    ProcessGroup
  34. def startProcessGroup[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcessGroup[Unit, E, Info]]

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    This is the most advanced way to start process groups. See start and +run as alternatives. +

    Info

    + The runner-specific information about the started processes

    runner

    + The process runner to be used

    returns

    + interface for handling the running process group

    Definition Classes
    ProcessGroup
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toFile(path: Path): ProcessGroupImplIOE[Unit, E]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for > +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  37. def toFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplIOE[O, E]

    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 ># +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  38. def toSink(sink: Prox.ProxSink[Byte]): ProcessGroupImplIOE[Unit, E]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  39. def toVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIOE[Vector[O], E]

    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 >? +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. 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
  44. 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
  45. val workingDirectory: Option[Path]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  46. object ConfigApplication
    Definition Classes
    ProcessGroupConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableOutput[[α$1$]ProcessGroupImplIOE[α$1$, E]]

Inherited from Prox.ProcessGroup[Unit, E]

Inherited from Prox.ProcessGroupConfiguration[Unit, E]

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplIO.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplIO.html new file mode 100644 index 00000000..2dfefcc2 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplIO.html @@ -0,0 +1,121 @@ +

Packages

case class ProcessGroupImplIO[O](firstProcess: UnboundEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundIEProcess[O], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[O, Unit] with Prox.RedirectableErrors[[β$0$]ProcessGroupImplIOE[O, β$0$]] with Product with Serializable

Process group with bound input and output streams

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableErrors[[β$0$]ProcessGroupImplIOE[O, β$0$]], Prox.ProcessGroup[O, Unit], Prox.ProcessGroupConfiguration[O, Unit], Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupImplIO
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableErrors
  6. ProcessGroup
  7. ProcessGroupConfiguration
  8. ProcessLikeConfiguration
  9. ProcessLike
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessGroupImplIO(firstProcess: UnboundEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundIEProcess[O], originalProcesses: List[Prox.Process[Unit, Unit]])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def !>(sink: Prox.ProxSink[Byte]): ProcessGroupImplIOE[O, Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  3. def !>#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplIOE[O, O]

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

    Redirects the error outputs 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 errorsToFoldMonoid +

    O

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

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  4. def !>?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIOE[O, Vector[O]]

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

    Redirects the error outputs 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 errorsToVector +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def connectErrors[R <: Prox.GroupErrorRedirection, OR <: Prox.OutputRedirection, E](target: R)(implicit groupErrorRedirectionType: Aux[R, OR, E], outputRedirectionType: Aux[OR, E]): ProcessGroupImplIOE[O, E]

    The low level operation to attach an error output to all the processes +in the group.

    The low level operation to attach an error output to all the processes +in the group.

    Use one of the other methods of this trait or the advanced interface +represented by customizedPerProcess for convenience.

    This is the place where the process group's error output type gets +calculated using the GroupErrorRedirectionType and +OutputRedirectionType type classes. +

    R

    + Error output grouped redirection type

    OR

    + Error output redirection type

    E

    + Error output type

    target

    + Redirection target

    groupErrorRedirectionType

    + Helper for dependent error output type

    outputRedirectionType

    + Helper for dependent error output type

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    ProcessGroupImplIO → RedirectableErrors
  11. lazy val customizedPerProcess: CustomizedPerProcess[[β$0$]ProcessGroupImplIOE[O, β$0$]]

    A more advanced interface for customizing the redirection per process

    A more advanced interface for customizing the redirection per process

    Definition Classes
    RedirectableErrors
  12. def drainErrors[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIOE[O, Unit]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  13. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def errorsToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplIOE[O, O]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  16. def errorsToSink(sink: Prox.ProxSink[Byte]): ProcessGroupImplIOE[O, Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  17. def errorsToVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplIOE[O, Vector[O]]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  18. val firstProcess: UnboundEProcess[Prox.ProxStream[Byte]]
    Definition Classes
    ProcessGroupImplIO → ProcessGroup
  19. def foldErrors[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplIOE[O, R]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  21. 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
  22. 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
  23. val innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]]
    Definition Classes
    ProcessGroupImplIO → ProcessGroup
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. val lastProcess: UnboundIEProcess[O]
    Definition Classes
    ProcessGroupImplIO → ProcessGroup
  26. def map(f: Mapper[O, Unit]): ProcessGroupImplIO[O]

    Applies the given mapper to each process in the group +

    Applies the given mapper to each process in the group +

    f

    + process mapper

    returns

    + a new process group with all the processes altered by the mapper

    Definition Classes
    ProcessGroupImplIO → ProcessGroup
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  30. val originalProcesses: List[Prox.Process[Unit, Unit]]
    Definition Classes
    ProcessGroupImplIO → ProcessGroup
  31. def productElementNames: Iterator[String]
    Definition Classes
    Product
  32. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  33. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessGroupResult[O, Unit]]

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

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

    runner

    + The process runner to be used

    returns

    + the result of the finished processes

    Definition Classes
    ProcessGroup
  34. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[O, Unit]]]

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Joining the fiber waits for the processes to be terminated. Canceling +the fiber terminates the processesnormally (with SIGTERM). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running processes

    Definition Classes
    ProcessGroup
  35. def startProcessGroup[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcessGroup[O, Unit, Info]]

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    This is the most advanced way to start process groups. See start and +run as alternatives. +

    Info

    + The runner-specific information about the started processes

    runner

    + The process runner to be used

    returns

    + interface for handling the running process group

    Definition Classes
    ProcessGroup
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. 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
  41. 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
  42. val workingDirectory: Option[Path]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  43. object ConfigApplication
    Definition Classes
    ProcessGroupConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableErrors[[β$0$]ProcessGroupImplIOE[O, β$0$]]

Inherited from Prox.ProcessGroup[O, Unit]

Inherited from Prox.ProcessGroupConfiguration[O, Unit]

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplIOE.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplIOE.html new file mode 100644 index 00000000..966e4197 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplIOE.html @@ -0,0 +1,49 @@ +

Packages

case class ProcessGroupImplIOE[O, E](firstProcess: Prox.Process[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIProcess[O, E], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[O, E] with Product with Serializable

Process group with bound input, output and error streams

Linear Supertypes
Serializable, Product, Equals, Prox.ProcessGroup[O, E], Prox.ProcessGroupConfiguration[O, E], Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupImplIOE
  2. Serializable
  3. Product
  4. Equals
  5. ProcessGroup
  6. ProcessGroupConfiguration
  7. ProcessLikeConfiguration
  8. ProcessLike
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessGroupImplIOE(firstProcess: Prox.Process[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIProcess[O, E], originalProcesses: List[Prox.Process[Unit, Unit]])

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
    ProcessGroupConfiguration → 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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val firstProcess: Prox.Process[Prox.ProxStream[Byte], E]
    Definition Classes
    ProcessGroupImplIOE → ProcessGroup
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. 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
  12. 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
  13. val innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]]
    Definition Classes
    ProcessGroupImplIOE → ProcessGroup
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val lastProcess: UnboundIProcess[O, E]
    Definition Classes
    ProcessGroupImplIOE → ProcessGroup
  16. def map(f: Mapper[O, E]): ProcessGroupImplIOE[O, E]

    Applies the given mapper to each process in the group +

    Applies the given mapper to each process in the group +

    f

    + process mapper

    returns

    + a new process group with all the processes altered by the mapper

    Definition Classes
    ProcessGroupImplIOE → ProcessGroup
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. val originalProcesses: List[Prox.Process[Unit, Unit]]
    Definition Classes
    ProcessGroupImplIOE → ProcessGroup
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  23. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessGroupResult[O, E]]

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

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

    runner

    + The process runner to be used

    returns

    + the result of the finished processes

    Definition Classes
    ProcessGroup
  24. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[O, E]]]

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Joining the fiber waits for the processes to be terminated. Canceling +the fiber terminates the processesnormally (with SIGTERM). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running processes

    Definition Classes
    ProcessGroup
  25. def startProcessGroup[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcessGroup[O, E, Info]]

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    This is the most advanced way to start process groups. See start and +run as alternatives. +

    Info

    + The runner-specific information about the started processes

    runner

    + The process runner to be used

    returns

    + interface for handling the running process group

    Definition Classes
    ProcessGroup
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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
  31. 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
  32. val workingDirectory: Option[Path]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  33. object ConfigApplication
    Definition Classes
    ProcessGroupConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.ProcessGroup[O, E]

Inherited from Prox.ProcessGroupConfiguration[O, E]

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplO.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplO.html new file mode 100644 index 00000000..f52f14f4 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplO.html @@ -0,0 +1,148 @@ +

Packages

case class ProcessGroupImplO[O](firstProcess: UnboundIEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundIEProcess[O], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[O, Unit] with Prox.RedirectableInput[ProcessGroupImplIO[O]] with Prox.RedirectableErrors[[β$4$]ProcessGroupImplOE[O, β$4$]] with Product with Serializable

Process group with bound output stream

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableErrors[[β$4$]ProcessGroupImplOE[O, β$4$]], Prox.RedirectableInput[ProcessGroupImplIO[O]], Prox.ProcessGroup[O, Unit], Prox.ProcessGroupConfiguration[O, Unit], Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupImplO
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableErrors
  6. RedirectableInput
  7. ProcessGroup
  8. ProcessGroupConfiguration
  9. ProcessLikeConfiguration
  10. ProcessLike
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessGroupImplO(firstProcess: UnboundIEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundIEProcess[O], originalProcesses: List[Prox.Process[Unit, Unit]])

Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): ProcessGroupImplIO[O]

    Feed the process input from a byte stream with flushing per chunks +enabled.

    Feed the process input from a byte stream with flushing per chunks +enabled.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. def !>(sink: Prox.ProxSink[Byte]): ProcessGroupImplOE[O, Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

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

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

    Redirects the error outputs 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 errorsToFoldMonoid +

    O

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

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  5. def !>?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplOE[O, Vector[O]]

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

    Redirects the error outputs 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 errorsToVector +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  6. final def ##: Int
    Definition Classes
    AnyRef → Any
  7. def <(stream: Prox.ProxStream[Byte]): ProcessGroupImplIO[O]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  8. def <(path: Path): ProcessGroupImplIO[O]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. def connectErrors[R <: Prox.GroupErrorRedirection, OR <: Prox.OutputRedirection, E](target: R)(implicit groupErrorRedirectionType: Aux[R, OR, E], outputRedirectionType: Aux[OR, E]): ProcessGroupImplOE[O, E]

    The low level operation to attach an error output to all the processes +in the group.

    The low level operation to attach an error output to all the processes +in the group.

    Use one of the other methods of this trait or the advanced interface +represented by customizedPerProcess for convenience.

    This is the place where the process group's error output type gets +calculated using the GroupErrorRedirectionType and +OutputRedirectionType type classes. +

    R

    + Error output grouped redirection type

    OR

    + Error output redirection type

    E

    + Error output type

    target

    + Redirection target

    groupErrorRedirectionType

    + Helper for dependent error output type

    outputRedirectionType

    + Helper for dependent error output type

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    ProcessGroupImplO → RedirectableErrors
  14. def connectInput(source: Prox.InputRedirection): ProcessGroupImplIO[O]

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience. +

    source

    + Redirection source

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    ProcessGroupImplO → RedirectableInput
  15. lazy val customizedPerProcess: CustomizedPerProcess[[β$4$]ProcessGroupImplOE[O, β$4$]]

    A more advanced interface for customizing the redirection per process

    A more advanced interface for customizing the redirection per process

    Definition Classes
    RedirectableErrors
  16. def drainErrors[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplOE[O, Unit]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  17. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def errorsToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessGroupImplOE[O, O]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  20. def errorsToSink(sink: Prox.ProxSink[Byte]): ProcessGroupImplOE[O, Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  21. def errorsToVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessGroupImplOE[O, Vector[O]]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  22. val firstProcess: UnboundIEProcess[Prox.ProxStream[Byte]]
    Definition Classes
    ProcessGroupImplO → ProcessGroup
  23. def foldErrors[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplOE[O, R]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

    Definition Classes
    RedirectableErrors
  24. def fromFile(path: Path): ProcessGroupImplIO[O]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  25. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): ProcessGroupImplIO[O]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<. +

    stream

    + Input stream

    flushChunks

    + Flush the process input stream after each chunk

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  27. 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
  28. 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
  29. val innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]]
    Definition Classes
    ProcessGroupImplO → ProcessGroup
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. val lastProcess: UnboundIEProcess[O]
    Definition Classes
    ProcessGroupImplO → ProcessGroup
  32. def map(f: Mapper[O, Unit]): ProcessGroupImplO[O]

    Applies the given mapper to each process in the group +

    Applies the given mapper to each process in the group +

    f

    + process mapper

    returns

    + a new process group with all the processes altered by the mapper

    Definition Classes
    ProcessGroupImplO → ProcessGroup
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  36. val originalProcesses: List[Prox.Process[Unit, Unit]]
    Definition Classes
    ProcessGroupImplO → ProcessGroup
  37. def productElementNames: Iterator[String]
    Definition Classes
    Product
  38. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  39. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessGroupResult[O, Unit]]

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

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

    runner

    + The process runner to be used

    returns

    + the result of the finished processes

    Definition Classes
    ProcessGroup
  40. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[O, Unit]]]

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Joining the fiber waits for the processes to be terminated. Canceling +the fiber terminates the processesnormally (with SIGTERM). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running processes

    Definition Classes
    ProcessGroup
  41. def startProcessGroup[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcessGroup[O, Unit, Info]]

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    This is the most advanced way to start process groups. See start and +run as alternatives. +

    Info

    + The runner-specific information about the started processes

    runner

    + The process runner to be used

    returns

    + interface for handling the running process group

    Definition Classes
    ProcessGroup
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  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 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
  48. val workingDirectory: Option[Path]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  49. object ConfigApplication
    Definition Classes
    ProcessGroupConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableErrors[[β$4$]ProcessGroupImplOE[O, β$4$]]

Inherited from Prox.RedirectableInput[ProcessGroupImplIO[O]]

Inherited from Prox.ProcessGroup[O, Unit]

Inherited from Prox.ProcessGroupConfiguration[O, Unit]

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplOE.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplOE.html new file mode 100644 index 00000000..557be966 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$$ProcessGroupImplOE.html @@ -0,0 +1,76 @@ +

Packages

case class ProcessGroupImplOE[O, E](firstProcess: UnboundIProcess[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIProcess[O, E], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[O, E] with Prox.RedirectableInput[ProcessGroupImplIOE[O, E]] with Product with Serializable

Process group with bound output and error streams

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableInput[ProcessGroupImplIOE[O, E]], Prox.ProcessGroup[O, E], Prox.ProcessGroupConfiguration[O, E], Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupImplOE
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableInput
  6. ProcessGroup
  7. ProcessGroupConfiguration
  8. ProcessLikeConfiguration
  9. ProcessLike
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessGroupImplOE(firstProcess: UnboundIProcess[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIProcess[O, E], originalProcesses: List[Prox.Process[Unit, Unit]])

Type Members

  1. type Self = ProcessGroupImplOE[O, E]
    Definition Classes
    ProcessGroupImplOE → ProcessGroupConfiguration → ProcessLikeConfiguration
  2. class ConfigApplication[P <: Prox.ProcessLikeConfiguration] extends AnyRef
    Definition Classes
    ProcessGroupConfiguration

Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): ProcessGroupImplIOE[O, E]

    Feed the process input from a byte stream with flushing per chunks +enabled.

    Feed the process input from a byte stream with flushing per chunks +enabled.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. def <(stream: Prox.ProxStream[Byte]): ProcessGroupImplIOE[O, E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  5. def <(path: Path): ProcessGroupImplIOE[O, E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def connectInput(source: Prox.InputRedirection): ProcessGroupImplIOE[O, E]

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience. +

    source

    + Redirection source

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    ProcessGroupImplOE → RedirectableInput
  11. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val firstProcess: UnboundIProcess[Prox.ProxStream[Byte], E]
    Definition Classes
    ProcessGroupImplOE → ProcessGroup
  14. def fromFile(path: Path): ProcessGroupImplIOE[O, E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  15. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): ProcessGroupImplIOE[O, E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<. +

    stream

    + Input stream

    flushChunks

    + Flush the process input stream after each chunk

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. 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
  18. 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
  19. val innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]]
    Definition Classes
    ProcessGroupImplOE → ProcessGroup
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val lastProcess: UnboundIProcess[O, E]
    Definition Classes
    ProcessGroupImplOE → ProcessGroup
  22. def map(f: Mapper[O, E]): ProcessGroupImplOE[O, E]

    Applies the given mapper to each process in the group +

    Applies the given mapper to each process in the group +

    f

    + process mapper

    returns

    + a new process group with all the processes altered by the mapper

    Definition Classes
    ProcessGroupImplOE → ProcessGroup
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  26. val originalProcesses: List[Prox.Process[Unit, Unit]]
    Definition Classes
    ProcessGroupImplOE → ProcessGroup
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  29. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessGroupResult[O, E]]

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

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

    runner

    + The process runner to be used

    returns

    + the result of the finished processes

    Definition Classes
    ProcessGroup
  30. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[O, E]]]

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Joining the fiber waits for the processes to be terminated. Canceling +the fiber terminates the processesnormally (with SIGTERM). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running processes

    Definition Classes
    ProcessGroup
  31. def startProcessGroup[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcessGroup[O, E, Info]]

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    This is the most advanced way to start process groups. See start and +run as alternatives. +

    Info

    + The runner-specific information about the started processes

    runner

    + The process runner to be used

    returns

    + interface for handling the running process group

    Definition Classes
    ProcessGroup
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. 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
  37. 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
  38. val workingDirectory: Option[Path]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  39. object ConfigApplication
    Definition Classes
    ProcessGroupConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableInput[ProcessGroupImplIOE[O, E]]

Inherited from Prox.ProcessGroup[O, E]

Inherited from Prox.ProcessGroupConfiguration[O, E]

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$.html new file mode 100644 index 00000000..459b24cb --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup$.html @@ -0,0 +1,10 @@ +

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 ProcessGroupModule extends AnyRef
    Definition Classes
    prox
  • ProcessGroup
  • ProcessGroupConfiguration
  • ProcessGroupResult
  • RunningProcessGroup
  • SimpleProcessGroupResult

object ProcessGroup

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

Type Members

  1. trait Mapper[O, E] extends AnyRef

    Mapper functions for altering a process group

  2. case class ProcessGroupImpl(firstProcess: UnboundIEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundProcess, originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[Unit, Unit] with Prox.RedirectableOutput[[α$6$]ProcessGroupImplO[α$6$]] with Prox.RedirectableInput[ProcessGroupImplI] with Prox.RedirectableErrors[[α$7$]ProcessGroupImplE[α$7$]] with Product with Serializable

    Process group with unbound input, output and error streams

  3. case class ProcessGroupImplE[E](firstProcess: UnboundIProcess[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIOProcess[E], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[Unit, E] with Prox.RedirectableOutput[[α$5$]ProcessGroupImplOE[α$5$, E]] with Prox.RedirectableInput[ProcessGroupImplIE[E]] with Product with Serializable

    Process group with bound error stream

  4. case class ProcessGroupImplI(firstProcess: UnboundEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundProcess, originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[Unit, Unit] with Prox.RedirectableOutput[[α$2$]ProcessGroupImplIO[α$2$]] with Prox.RedirectableErrors[[α$3$]ProcessGroupImplIE[α$3$]] with Product with Serializable

    Process group with bound input stream

  5. case class ProcessGroupImplIE[E](firstProcess: Prox.Process[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIOProcess[E], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[Unit, E] with Prox.RedirectableOutput[[α$1$]ProcessGroupImplIOE[α$1$, E]] with Product with Serializable

    Process group with bound input and error streams

  6. case class ProcessGroupImplIO[O](firstProcess: UnboundEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundIEProcess[O], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[O, Unit] with Prox.RedirectableErrors[[β$0$]ProcessGroupImplIOE[O, β$0$]] with Product with Serializable

    Process group with bound input and output streams

  7. case class ProcessGroupImplIOE[O, E](firstProcess: Prox.Process[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIProcess[O, E], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[O, E] with Product with Serializable

    Process group with bound input, output and error streams

  8. case class ProcessGroupImplO[O](firstProcess: UnboundIEProcess[Prox.ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[Prox.ProxStream[Byte]]], lastProcess: UnboundIEProcess[O], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[O, Unit] with Prox.RedirectableInput[ProcessGroupImplIO[O]] with Prox.RedirectableErrors[[β$4$]ProcessGroupImplOE[O, β$4$]] with Product with Serializable

    Process group with bound output stream

  9. case class ProcessGroupImplOE[O, E](firstProcess: UnboundIProcess[Prox.ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]], lastProcess: UnboundIProcess[O, E], originalProcesses: List[Prox.Process[Unit, Unit]]) extends Prox.ProcessGroup[O, E] with Prox.RedirectableInput[ProcessGroupImplIOE[O, E]] with Product with Serializable

    Process group with bound output and error streams

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup.html new file mode 100644 index 00000000..73c130ab --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroup.html @@ -0,0 +1,57 @@ +

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 ProcessGroupModule extends AnyRef
    Definition Classes
    prox
  • ProcessGroup
  • ProcessGroupConfiguration
  • ProcessGroupResult
  • RunningProcessGroup
  • SimpleProcessGroupResult

trait ProcessGroup[O, E] extends ProcessLike with Prox.ProcessGroupConfiguration[O, E]

Process group is two or more processes attached to each other

This implements a pipeline of processes. The input of the first process +and the output of the last process is redirectable with the +RedirectableInput and RedirectableOutput traits. The processes are +attached to each other's input/output streams, the pipe between them is +customizable.

The error streams are also redirectable with the RedirectableErrors +trait. +

O

+ Output type

E

+ Error output type

Linear Supertypes
Prox.ProcessGroupConfiguration[O, E], Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Known Subclasses
ProcessGroupImpl, ProcessGroupImplE, ProcessGroupImplI, ProcessGroupImplIE, ProcessGroupImplIO, ProcessGroupImplIOE, ProcessGroupImplO, ProcessGroupImplOE
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroup
  2. ProcessGroupConfiguration
  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 <: Prox.ProcessGroup[O, E]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  2. class ConfigApplication[P <: Prox.ProcessLikeConfiguration] extends AnyRef
    Definition Classes
    ProcessGroupConfiguration

Abstract Value Members

  1. abstract val firstProcess: Prox.Process[Prox.ProxStream[Byte], E]
  2. abstract val innerProcesses: List[UnboundIProcess[Prox.ProxStream[Byte], E]]
  3. abstract val lastProcess: UnboundIProcess[O, E]
  4. abstract def map(f: Mapper[O, E]): Self

    Applies the given mapper to each process in the group +

    Applies the given mapper to each process in the group +

    f

    + process mapper

    returns

    + a new process group with all the processes altered by the mapper

  5. abstract val originalProcesses: List[Prox.Process[Unit, Unit]]

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
    ProcessGroupConfiguration → 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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @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
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  18. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  19. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessGroupResult[O, E]]

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

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

    runner

    + The process runner to be used

    returns

    + the result of the finished processes

  20. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[O, E]]]

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Starts the process group asynchronously and returns a closeable fiber +representing it

    Joining the fiber waits for the processes to be terminated. Canceling +the fiber terminates the processesnormally (with SIGTERM). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running processes

  21. def startProcessGroup[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcessGroup[O, E, Info]]

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    Starts the process group asynchronously and returns the +RunningProcessGroup interface for it

    This is the most advanced way to start process groups. See start and +run as alternatives. +

    Info

    + The runner-specific information about the started processes

    runner

    + The process runner to be used

    returns

    + interface for handling the running process group

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

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox.ProcessGroupConfiguration[O, E]

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupConfiguration$ConfigApplication$.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupConfiguration$ConfigApplication$.html new file mode 100644 index 00000000..6e14ae2c --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupConfiguration$ConfigApplication$.html @@ -0,0 +1,10 @@ +

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 ProcessGroupModule extends AnyRef
    Definition Classes
    prox
  • trait ProcessGroupConfiguration[O, E] extends Prox.ProcessLikeConfiguration
    Definition Classes
    ProcessGroupModule
  • ConfigApplication
  • Self

object ConfigApplication

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

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[P <: Prox.ProcessLikeConfiguration]: ProcessGroup.ConfigApplication[P]
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupConfiguration$ConfigApplication.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupConfiguration$ConfigApplication.html new file mode 100644 index 00000000..129d33d8 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupConfiguration$ConfigApplication.html @@ -0,0 +1,10 @@ +

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 ProcessGroupModule extends AnyRef
    Definition Classes
    prox
  • trait ProcessGroupConfiguration[O, E] extends Prox.ProcessLikeConfiguration
    Definition Classes
    ProcessGroupModule
  • ConfigApplication
  • Self

class ConfigApplication[P <: Prox.ProcessLikeConfiguration] extends AnyRef

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

Instance Constructors

  1. new ConfigApplication()

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(process: P, workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): P
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupConfiguration.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupConfiguration.html new file mode 100644 index 00000000..c563ae1d --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupConfiguration.html @@ -0,0 +1,26 @@ +

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 ProcessGroupModule extends AnyRef
    Definition Classes
    prox
  • ProcessGroup
  • ProcessGroupConfiguration
  • ProcessGroupResult
  • RunningProcessGroup
  • SimpleProcessGroupResult
t

io.github.vigoo.prox.ProcessGroupModule

ProcessGroupConfiguration

trait ProcessGroupConfiguration[O, E] extends Prox.ProcessLikeConfiguration

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupConfiguration
  2. ProcessLikeConfiguration
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class ConfigApplication[P <: Prox.ProcessLikeConfiguration] extends AnyRef
  2. abstract type Self <: Prox.ProcessGroup[O, E]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration

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]): ProcessGroup.Self
    Attributes
    protected
    Definition Classes
    ProcessGroupConfiguration → 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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def in(workingDirectory: Path): ProcessGroup.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(): ProcessGroup.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
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  18. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. def with(nameValuePair: (String, String)): ProcessGroup.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
  25. def without(name: String): ProcessGroup.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
  26. val workingDirectory: Option[Path]
    Definition Classes
    ProcessGroupConfiguration → ProcessLikeConfiguration
  27. object ConfigApplication

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox.ProcessLikeConfiguration

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupResult.html b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupResult.html new file mode 100644 index 00000000..d9ddb83a --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$ProcessGroupResult.html @@ -0,0 +1,17 @@ +

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 ProcessGroupModule extends AnyRef
    Definition Classes
    prox
  • ProcessGroup
  • ProcessGroupConfiguration
  • ProcessGroupResult
  • RunningProcessGroup
  • SimpleProcessGroupResult

trait ProcessGroupResult[+O, +E] extends AnyRef

Result of an executed process group +

O

+ Output type

E

+ Error output type

Linear Supertypes
AnyRef, Any
Known Subclasses
SimpleProcessGroupResult
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupResult
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val errors: Map[Prox.Process[Unit, Unit], E]

    Per-process error outputs.

    Per-process error outputs. The key is the original process passed to the +piping operator +

  2. abstract val exitCodes: Map[Prox.Process[Unit, Unit], Prox.ProxExitCode]

    Per-process exit codes.

    Per-process exit codes. The key is the original process passed to the +piping operator +

  3. abstract val output: O

    Output of the last process in the group

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$RunningProcessGroup.html b/api/io/github/vigoo/prox/ProcessGroupModule$RunningProcessGroup.html new file mode 100644 index 00000000..9c4cd706 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$RunningProcessGroup.html @@ -0,0 +1,15 @@ +

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 ProcessGroupModule extends AnyRef
    Definition Classes
    prox
  • ProcessGroup
  • ProcessGroupConfiguration
  • ProcessGroupResult
  • RunningProcessGroup
  • SimpleProcessGroupResult

trait RunningProcessGroup[O, E, +Info] extends AnyRef

Representation of a running process group +

O

+ Output type

E

+ Error output type

Info

+ Runner-specific per-process information type

Linear Supertypes
AnyRef, Any
Known Subclasses
JVMRunningProcessGroup
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RunningProcessGroup
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val info: Map[Prox.Process[Unit, Unit], Info]

    Runner-specific information about each running process

  2. abstract def kill(): Prox.ProxIO[Prox.ProcessGroupResult[O, E]]

    Forcibly terminates all processes in the group.

    Forcibly terminates all processes in the group. Blocks until it is done. +

  3. abstract val runningOutput: Prox.ProxFiber[O]
  4. abstract def terminate(): Prox.ProxIO[Prox.ProcessGroupResult[O, E]]

    Terminates all processes in the group.

    Terminates all processes in the group. Blocks until it is done.

  5. abstract def waitForExit(): Prox.ProxIO[Prox.ProcessGroupResult[O, E]]

    Blocks until the processes finish running

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def mapInfo[I2](f: (Prox.Process[Unit, Unit], Info) => I2): Prox.RunningProcessGroup[O, E, I2]
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule$SimpleProcessGroupResult.html b/api/io/github/vigoo/prox/ProcessGroupModule$SimpleProcessGroupResult.html new file mode 100644 index 00000000..ea40fc1f --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule$SimpleProcessGroupResult.html @@ -0,0 +1,14 @@ +

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 ProcessGroupModule extends AnyRef
    Definition Classes
    prox
  • ProcessGroup
  • ProcessGroupConfiguration
  • ProcessGroupResult
  • RunningProcessGroup
  • SimpleProcessGroupResult
c

io.github.vigoo.prox.ProcessGroupModule

SimpleProcessGroupResult

case class SimpleProcessGroupResult[+O, +E](exitCodes: Map[Prox.Process[Unit, Unit], Prox.ProxExitCode], output: O, errors: Map[Prox.Process[Unit, Unit], E]) extends Prox.ProcessGroupResult[O, E] with Product with Serializable

Default implementation of ProcessGroupResult

Linear Supertypes
Serializable, Product, Equals, Prox.ProcessGroupResult[O, E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleProcessGroupResult
  2. Serializable
  3. Product
  4. Equals
  5. ProcessGroupResult
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SimpleProcessGroupResult(exitCodes: Map[Prox.Process[Unit, Unit], Prox.ProxExitCode], output: O, errors: Map[Prox.Process[Unit, Unit], E])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val errors: Map[Prox.Process[Unit, Unit], E]

    Per-process error outputs.

    Per-process error outputs. The key is the original process passed to the +piping operator +

    Definition Classes
    SimpleProcessGroupResult → ProcessGroupResult
  8. val exitCodes: Map[Prox.Process[Unit, Unit], Prox.ProxExitCode]

    Per-process exit codes.

    Per-process exit codes. The key is the original process passed to the +piping operator +

    Definition Classes
    SimpleProcessGroupResult → ProcessGroupResult
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. val output: O

    Output of the last process in the group

    Output of the last process in the group

    Definition Classes
    SimpleProcessGroupResult → ProcessGroupResult
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.ProcessGroupResult[O, E]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessGroupModule.html b/api/io/github/vigoo/prox/ProcessGroupModule.html new file mode 100644 index 00000000..fd79836b --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessGroupModule.html @@ -0,0 +1,27 @@ +

Packages

t

io.github.vigoo.prox

ProcessGroupModule

trait ProcessGroupModule extends AnyRef

Self Type
Prox
Linear Supertypes
AnyRef, Any
Known Subclasses
Prox, ProxFS2, ProxZStream, zstream
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessGroupModule
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait ProcessGroup[O, E] extends ProcessLike with Prox.ProcessGroupConfiguration[O, E]

    Process group is two or more processes attached to each other

    Process group is two or more processes attached to each other

    This implements a pipeline of processes. The input of the first process +and the output of the last process is redirectable with the +RedirectableInput and RedirectableOutput traits. The processes are +attached to each other's input/output streams, the pipe between them is +customizable.

    The error streams are also redirectable with the RedirectableErrors +trait. +

    O

    + Output type

    E

    + Error output type

  2. trait ProcessGroupConfiguration[O, E] extends Prox.ProcessLikeConfiguration
  3. trait ProcessGroupResult[+O, +E] extends AnyRef

    Result of an executed process group +

    Result of an executed process group +

    O

    + Output type

    E

    + Error output type

  4. trait RunningProcessGroup[O, E, +Info] extends AnyRef

    Representation of a running process group +

    Representation of a running process group +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific per-process information type

  5. case class SimpleProcessGroupResult[+O, +E](exitCodes: Map[Prox.Process[Unit, Unit], Prox.ProxExitCode], output: O, errors: Map[Prox.Process[Unit, Unit], E]) extends Prox.ProcessGroupResult[O, E] with Product with Serializable

    Default implementation of ProcessGroupResult

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. object ProcessGroup

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImpl.html b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImpl.html new file mode 100644 index 00000000..c273ef45 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImpl.html @@ -0,0 +1,235 @@ +

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 ProcessImpl(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[Unit], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[Unit], inputRedirection: Prox.InputRedirection) extends Prox.Process[Unit, Unit] with Prox.RedirectableOutput[[α$14$]ProcessImplO[α$14$]] with Prox.RedirectableError[[α$15$]ProcessImplE[α$15$]] with Prox.RedirectableInput[ProcessImplI] with Product with Serializable

Process with no streams bound

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableInput[ProcessImplI], Prox.RedirectableError[[α$15$]ProcessImplE[α$15$]], Prox.RedirectableOutput[[α$14$]ProcessImplO[α$14$]], Prox.Process[Unit, Unit], Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessImpl
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableInput
  6. RedirectableError
  7. RedirectableOutput
  8. Process
  9. ProcessConfiguration
  10. ProcessLikeConfiguration
  11. ProcessLike
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

Type Members

  1. type Self = ProcessImpl
    Definition Classes
    ProcessImpl → Process → ProcessLikeConfiguration

Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): ProcessImplI

    Feed the process input from a byte stream with flushing per chunks +enabled.

    Feed the process input from a byte stream with flushing per chunks +enabled.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. def !>(path: Path): ProcessImplE[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
  4. def !>(sink: Prox.ProxSink[Byte]): ProcessImplE[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
  5. def !>#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplE[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
  6. def !>>(path: Path): ProcessImplE[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
  7. def !>?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplE[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
  8. final def ##: Int
    Definition Classes
    AnyRef → Any
  9. def <(stream: Prox.ProxStream[Byte]): ProcessImplI

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  10. def <(path: Path): ProcessImplI

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  11. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def >(path: Path): ProcessImplO[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for toFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  13. def >(sink: Prox.ProxSink[Byte]): ProcessImplO[Unit]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  14. def >#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplO[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 +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  15. def >>(path: Path): ProcessImplO[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 +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  16. def >?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplO[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 +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  17. def appendErrorToFile(path: Path): ProcessImplE[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
  18. def appendToFile(path: Path): ProcessImplO[Unit]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for >> +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  19. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration → ProcessLikeConfiguration
  20. val arguments: List[String]
    Definition Classes
    ProcessImpl → Process
  21. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  23. val command: String
    Definition Classes
    ProcessImpl → Process
  24. def connectError[R <: Prox.OutputRedirection, RE](target: R)(implicit outputRedirectionType: Aux[R, RE]): ProcessImplE[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
    ProcessImpl → RedirectableError
  25. def connectInput(source: Prox.InputRedirection): ProcessImplI

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience. +

    source

    + Redirection source

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    ProcessImpl → RedirectableInput
  26. def connectOutput[R <: Prox.OutputRedirection, RO](target: R)(implicit outputRedirectionType: Aux[R, RO]): ProcessImplO[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. +

    R

    + Output redirection type

    target

    + Redirection target

    outputRedirectionType

    + Helper for dependent output type

    returns

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

    Definition Classes
    ProcessImpl → RedirectableOutput
  27. def drainError[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplE[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
  28. def drainOutput[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplO[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. +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  29. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessImpl → Process → ProcessLikeConfiguration
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImpl → Process
  32. def errorToFile(path: Path): ProcessImplE[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
  33. def errorToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplE[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
  34. def errorToSink(sink: Prox.ProxSink[Byte]): ProcessImplE[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
  35. def errorToVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplE[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
  36. def foldError[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessImplE[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
  37. def foldOutput[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessImplO[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. +

    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 or process group with its output redirected and + its output redirection capability removed.

    Definition Classes
    RedirectableOutput
  38. def fromFile(path: Path): ProcessImplI

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  39. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): ProcessImplI

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<. +

    stream

    + Input stream

    flushChunks

    + Flush the process input stream after each chunk

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  40. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  41. 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
  42. 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
  43. val inputRedirection: Prox.InputRedirection
    Definition Classes
    ProcessImpl → Process
  44. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  48. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImpl → Process
  49. def productElementNames: Iterator[String]
    Definition Classes
    Product
  50. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessImpl → Process → ProcessLikeConfiguration
  51. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessResult[Unit, 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
  52. val runErrorStream: (InputStream) => Prox.ProxIO[Unit]
    Definition Classes
    ProcessImpl → Process
  53. val runOutputStream: (InputStream) => Prox.ProxIO[Unit]
    Definition Classes
    ProcessImpl → Process
  54. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImpl
    Attributes
    protected
    Definition Classes
    ProcessImpl → ProcessConfiguration
  55. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessResult[Unit, 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
  56. def startProcess[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcess[Unit, 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
  57. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  58. def toFile(path: Path): ProcessImplO[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for > +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  59. def toFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplO[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 ># +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  60. def toSink(sink: Prox.ProxSink[Byte]): ProcessImplO[Unit]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  61. def toVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplO[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 >? +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  65. 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
  66. 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
  67. 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
  68. 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
  69. val workingDirectory: Option[Path]
    Definition Classes
    ProcessImpl → Process → ProcessLikeConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableInput[ProcessImplI]

Inherited from Prox.RedirectableError[[α$15$]ProcessImplE[α$15$]]

Inherited from Prox.RedirectableOutput[[α$14$]ProcessImplO[α$14$]]

Inherited from Prox.Process[Unit, Unit]

Inherited from Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplE.html b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplE.html new file mode 100644 index 00000000..7d7f1be0 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplE.html @@ -0,0 +1,156 @@ +

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 ProcessImplE[E](command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[Unit], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[E], inputRedirection: Prox.InputRedirection) extends Prox.Process[Unit, E] with Prox.RedirectableInput[ProcessImplIE[E]] with Prox.RedirectableOutput[[α$11$]ProcessImplOE[α$11$, E]] with Product with Serializable

Process with bound error streams

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableOutput[[α$11$]ProcessImplOE[α$11$, E]], Prox.RedirectableInput[ProcessImplIE[E]], Prox.Process[Unit, E], Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessImplE
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableOutput
  6. RedirectableInput
  7. Process
  8. ProcessConfiguration
  9. ProcessLikeConfiguration
  10. ProcessLike
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

Type Members

  1. type Self = ProcessImplE[E]
    Definition Classes
    ProcessImplE → Process → ProcessLikeConfiguration

Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): ProcessImplIE[E]

    Feed the process input from a byte stream with flushing per chunks +enabled.

    Feed the process input from a byte stream with flushing per chunks +enabled.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. def <(stream: Prox.ProxStream[Byte]): ProcessImplIE[E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  5. def <(path: Path): ProcessImplIE[E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def >(path: Path): ProcessImplOE[Unit, E]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for toFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  8. def >(sink: Prox.ProxSink[Byte]): ProcessImplOE[Unit, E]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  9. def >#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplOE[O, E]

    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 +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  10. def >>(path: Path): ProcessImplOE[Unit, E]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for appendToFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  11. def >?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplOE[Vector[O], E]

    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 +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  12. def appendToFile(path: Path): ProcessImplOE[Unit, E]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for >> +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  13. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration → ProcessLikeConfiguration
  14. val arguments: List[String]
    Definition Classes
    ProcessImplE → Process
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. val command: String
    Definition Classes
    ProcessImplE → Process
  18. def connectInput(source: Prox.InputRedirection): ProcessImplIE[E]

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience. +

    source

    + Redirection source

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    ProcessImplE → RedirectableInput
  19. def connectOutput[R <: Prox.OutputRedirection, RO](target: R)(implicit outputRedirectionType: Aux[R, RO]): ProcessImplOE[RO, E]

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

    R

    + Output redirection type

    target

    + Redirection target

    outputRedirectionType

    + Helper for dependent output type

    returns

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

    Definition Classes
    ProcessImplE → RedirectableOutput
  20. def drainOutput[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplOE[Unit, E]

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

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  21. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessImplE → Process → ProcessLikeConfiguration
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplE → Process
  24. def foldOutput[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessImplOE[R, E]

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

    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 or process group with its output redirected and + its output redirection capability removed.

    Definition Classes
    RedirectableOutput
  25. def fromFile(path: Path): ProcessImplIE[E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  26. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): ProcessImplIE[E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<. +

    stream

    + Input stream

    flushChunks

    + Flush the process input stream after each chunk

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  28. 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
  29. 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
  30. val inputRedirection: Prox.InputRedirection
    Definition Classes
    ProcessImplE → Process
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  35. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplE → Process
  36. def productElementNames: Iterator[String]
    Definition Classes
    Product
  37. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessImplE → Process → ProcessLikeConfiguration
  38. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessResult[Unit, 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 +

    runner

    + The process runner to be used

    returns

    + the result of the finished process

    Definition Classes
    Process
  39. val runErrorStream: (InputStream) => Prox.ProxIO[E]
    Definition Classes
    ProcessImplE → Process
  40. val runOutputStream: (InputStream) => Prox.ProxIO[Unit]
    Definition Classes
    ProcessImplE → Process
  41. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImplE[E]
    Attributes
    protected
    Definition Classes
    ProcessImplE → ProcessConfiguration
  42. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessResult[Unit, 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). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running process

    Definition Classes
    Process
  43. def startProcess[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcess[Unit, 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. +

    Info

    + The runner-specific process info type

    runner

    + The process runner to be used

    returns

    + interface for handling the running process

    Definition Classes
    Process
  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. def toFile(path: Path): ProcessImplOE[Unit, E]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for > +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  46. def toFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplOE[O, E]

    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 ># +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  47. def toSink(sink: Prox.ProxSink[Byte]): ProcessImplOE[Unit, E]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  48. def toVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplOE[Vector[O], E]

    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 >? +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  52. 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
  53. 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
  54. 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
  55. 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
  56. val workingDirectory: Option[Path]
    Definition Classes
    ProcessImplE → Process → ProcessLikeConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableOutput[[α$11$]ProcessImplOE[α$11$, E]]

Inherited from Prox.RedirectableInput[ProcessImplIE[E]]

Inherited from Prox.Process[Unit, E]

Inherited from Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplI.html b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplI.html new file mode 100644 index 00000000..c77e8aad --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplI.html @@ -0,0 +1,208 @@ +

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 ProcessImplI(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[Unit], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[Unit], inputRedirection: Prox.InputRedirection) extends Prox.Process[Unit, Unit] with Prox.RedirectableOutput[[α$12$]ProcessImplIO[α$12$]] with Prox.RedirectableError[[α$13$]ProcessImplIE[α$13$]] with Product with Serializable

Process with bound input streams

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableError[[α$13$]ProcessImplIE[α$13$]], Prox.RedirectableOutput[[α$12$]ProcessImplIO[α$12$]], Prox.Process[Unit, Unit], Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessImplI
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableError
  6. RedirectableOutput
  7. Process
  8. ProcessConfiguration
  9. ProcessLikeConfiguration
  10. ProcessLike
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

Type Members

  1. type Self = ProcessImplI
    Definition Classes
    ProcessImplI → Process → ProcessLikeConfiguration

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def !>(path: Path): ProcessImplIE[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]): ProcessImplIE[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]): ProcessImplIE[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): ProcessImplIE[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]): ProcessImplIE[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 >(path: Path): ProcessImplIO[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for toFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  10. def >(sink: Prox.ProxSink[Byte]): ProcessImplIO[Unit]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  11. def >#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplIO[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 +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  12. def >>(path: Path): ProcessImplIO[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 +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  13. def >?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIO[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 +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  14. def appendErrorToFile(path: Path): ProcessImplIE[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
  15. def appendToFile(path: Path): ProcessImplIO[Unit]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for >> +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  16. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration → ProcessLikeConfiguration
  17. val arguments: List[String]
    Definition Classes
    ProcessImplI → Process
  18. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. val command: String
    Definition Classes
    ProcessImplI → Process
  21. def connectError[R <: Prox.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. +

    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
    ProcessImplI → RedirectableError
  22. def connectOutput[R <: Prox.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. +

    R

    + Output redirection type

    target

    + Redirection target

    outputRedirectionType

    + Helper for dependent output type

    returns

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

    Definition Classes
    ProcessImplI → RedirectableOutput
  23. def drainError[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIE[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
  24. def drainOutput[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIO[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. +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  25. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessImplI → Process → ProcessLikeConfiguration
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplI → Process
  28. def errorToFile(path: Path): ProcessImplIE[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
  29. def errorToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplIE[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
  30. def errorToSink(sink: Prox.ProxSink[Byte]): ProcessImplIE[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
  31. def errorToVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIE[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
  32. def foldError[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessImplIE[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
  33. def foldOutput[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessImplIO[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. +

    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 or process group with its output redirected and + its output redirection capability removed.

    Definition Classes
    RedirectableOutput
  34. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  35. 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
  36. 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
  37. val inputRedirection: Prox.InputRedirection
    Definition Classes
    ProcessImplI → Process
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  42. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplI → Process
  43. def productElementNames: Iterator[String]
    Definition Classes
    Product
  44. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessImplI → Process → ProcessLikeConfiguration
  45. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessResult[Unit, 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
  46. val runErrorStream: (InputStream) => Prox.ProxIO[Unit]
    Definition Classes
    ProcessImplI → Process
  47. val runOutputStream: (InputStream) => Prox.ProxIO[Unit]
    Definition Classes
    ProcessImplI → Process
  48. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImplI
    Attributes
    protected
    Definition Classes
    ProcessImplI → ProcessConfiguration
  49. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessResult[Unit, 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
  50. def startProcess[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcess[Unit, 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
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. def toFile(path: Path): ProcessImplIO[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for > +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  53. def toFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplIO[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 ># +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  54. def toSink(sink: Prox.ProxSink[Byte]): ProcessImplIO[Unit]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  55. def toVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIO[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 >? +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  59. 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
  60. 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
  61. 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
  62. 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
  63. val workingDirectory: Option[Path]
    Definition Classes
    ProcessImplI → Process → ProcessLikeConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableError[[α$13$]ProcessImplIE[α$13$]]

Inherited from Prox.RedirectableOutput[[α$12$]ProcessImplIO[α$12$]]

Inherited from Prox.Process[Unit, Unit]

Inherited from Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplIE.html b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplIE.html new file mode 100644 index 00000000..2f67c729 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplIE.html @@ -0,0 +1,129 @@ +

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 ProcessImplIE[E](command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[Unit], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[E], inputRedirection: Prox.InputRedirection) extends Prox.Process[Unit, E] with Prox.RedirectableOutput[[α$9$]ProcessImplIOE[α$9$, E]] with Product with Serializable

Process with bound input and error streams

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableOutput[[α$9$]ProcessImplIOE[α$9$, E]], Prox.Process[Unit, E], Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessImplIE
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableOutput
  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 ProcessImplIE(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[Unit], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[E], inputRedirection: Prox.InputRedirection)

Type Members

  1. type Self = ProcessImplIE[E]
    Definition Classes
    ProcessImplIE → Process → ProcessLikeConfiguration

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 >(path: Path): ProcessImplIOE[Unit, E]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for toFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  5. def >(sink: Prox.ProxSink[Byte]): ProcessImplIOE[Unit, E]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  6. def >#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplIOE[O, E]

    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 +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  7. def >>(path: Path): ProcessImplIOE[Unit, E]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for appendToFile +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  8. def >?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIOE[Vector[O], E]

    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 +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  9. def appendToFile(path: Path): ProcessImplIOE[Unit, E]

    Redirects the output to a file natively in append mode

    Redirects the output to a file natively in append mode

    An alias for >> +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  10. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration → ProcessLikeConfiguration
  11. val arguments: List[String]
    Definition Classes
    ProcessImplIE → Process
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. val command: String
    Definition Classes
    ProcessImplIE → Process
  15. def connectOutput[R <: Prox.OutputRedirection, RO](target: R)(implicit outputRedirectionType: Aux[R, RO]): ProcessImplIOE[RO, E]

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

    R

    + Output redirection type

    target

    + Redirection target

    outputRedirectionType

    + Helper for dependent output type

    returns

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

    Definition Classes
    ProcessImplIE → RedirectableOutput
  16. def drainOutput[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIOE[Unit, E]

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

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  17. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessImplIE → Process → ProcessLikeConfiguration
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplIE → Process
  20. def foldOutput[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessImplIOE[R, E]

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

    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 or process group with its output redirected and + its output redirection capability removed.

    Definition Classes
    RedirectableOutput
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  22. 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
  23. 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
  24. val inputRedirection: Prox.InputRedirection
    Definition Classes
    ProcessImplIE → Process
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  29. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplIE → Process
  30. def productElementNames: Iterator[String]
    Definition Classes
    Product
  31. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessImplIE → Process → ProcessLikeConfiguration
  32. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessResult[Unit, 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 +

    runner

    + The process runner to be used

    returns

    + the result of the finished process

    Definition Classes
    Process
  33. val runErrorStream: (InputStream) => Prox.ProxIO[E]
    Definition Classes
    ProcessImplIE → Process
  34. val runOutputStream: (InputStream) => Prox.ProxIO[Unit]
    Definition Classes
    ProcessImplIE → Process
  35. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImplIE[E]
    Attributes
    protected
    Definition Classes
    ProcessImplIE → ProcessConfiguration
  36. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessResult[Unit, 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). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running process

    Definition Classes
    Process
  37. def startProcess[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcess[Unit, 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. +

    Info

    + The runner-specific process info type

    runner

    + The process runner to be used

    returns

    + interface for handling the running process

    Definition Classes
    Process
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toFile(path: Path): ProcessImplIOE[Unit, E]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for > +

    path

    + Target file path

    returns

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

    Definition Classes
    RedirectableOutput
  40. def toFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplIOE[O, E]

    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 ># +

    O

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

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  41. def toSink(sink: Prox.ProxSink[Byte]): ProcessImplIOE[Unit, E]

    Redirects the output to a sink.

    Redirects the output to a sink.

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

    sink

    + Target sink

    returns

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

    Definition Classes
    RedirectableOutput
  42. def toVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplIOE[Vector[O], E]

    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 >? +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

    Definition Classes
    RedirectableOutput
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  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]
    Definition Classes
    ProcessImplIE → Process → ProcessLikeConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableOutput[[α$9$]ProcessImplIOE[α$9$, E]]

Inherited from Prox.Process[Unit, E]

Inherited from Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplIO.html b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplIO.html new file mode 100644 index 00000000..4c427c92 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplIO.html @@ -0,0 +1,132 @@ +

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
Serializable, Product, Equals, Prox.RedirectableError[[β$8$]ProcessImplIOE[O, β$8$]], Prox.Process[O, Unit], Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
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]
    Definition Classes
    ProcessImplIO → Process → ProcessLikeConfiguration

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
    ProcessConfiguration → ProcessLikeConfiguration
  11. val arguments: List[String]
    Definition Classes
    ProcessImplIO → Process
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. val command: String
    Definition Classes
    ProcessImplIO → Process
  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
    ProcessImplIO → RedirectableError
  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]
    Definition Classes
    ProcessImplIO → Process → ProcessLikeConfiguration
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplIO → Process
  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
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  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
    ProcessImplIO → Process
  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
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  33. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplIO → Process
  34. def productElementNames: Iterator[String]
    Definition Classes
    Product
  35. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessImplIO → Process → ProcessLikeConfiguration
  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
    ProcessImplIO → Process
  38. val runOutputStream: (InputStream) => Prox.ProxIO[O]
    Definition Classes
    ProcessImplIO → Process
  39. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImplIO[O]
    Attributes
    protected
    Definition Classes
    ProcessImplIO → ProcessConfiguration
  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(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  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]
    Definition Classes
    ProcessImplIO → Process → ProcessLikeConfiguration

Deprecated Value Members

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

    (Since version 9)

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 Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplIOE.html b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplIOE.html new file mode 100644 index 00000000..207d491d --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplIOE.html @@ -0,0 +1,53 @@ +

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 ProcessImplIOE[O, E](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[E], inputRedirection: Prox.InputRedirection) extends Prox.Process[O, E] with Product with Serializable

Process with bound input, output and error streams

Linear Supertypes
Serializable, Product, Equals, Prox.Process[O, E], Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessImplIOE
  2. Serializable
  3. Product
  4. Equals
  5. Process
  6. ProcessConfiguration
  7. ProcessLikeConfiguration
  8. ProcessLike
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessImplIOE(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[E], inputRedirection: Prox.InputRedirection)

Type Members

  1. type Self = ProcessImplIOE[O, E]
    Definition Classes
    ProcessImplIOE → Process → ProcessLikeConfiguration

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. val arguments: List[String]
    Definition Classes
    ProcessImplIOE → Process
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. val command: String
    Definition Classes
    ProcessImplIOE → Process
  9. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessImplIOE → Process → ProcessLikeConfiguration
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplIOE → Process
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. 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
  14. 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
  15. val inputRedirection: Prox.InputRedirection
    Definition Classes
    ProcessImplIOE → Process
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplIOE → Process
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessImplIOE → Process → ProcessLikeConfiguration
  23. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.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 +

    runner

    + The process runner to be used

    returns

    + the result of the finished process

    Definition Classes
    Process
  24. val runErrorStream: (InputStream) => Prox.ProxIO[E]
    Definition Classes
    ProcessImplIOE → Process
  25. val runOutputStream: (InputStream) => Prox.ProxIO[O]
    Definition Classes
    ProcessImplIOE → Process
  26. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImplIOE[O, E]
    Attributes
    protected
    Definition Classes
    ProcessImplIOE → ProcessConfiguration
  27. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.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). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running process

    Definition Classes
    Process
  28. def startProcess[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.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. +

    Info

    + The runner-specific process info type

    runner

    + The process runner to be used

    returns

    + interface for handling the running process

    Definition Classes
    Process
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. 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
  34. 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
  35. 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
  36. 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
  37. val workingDirectory: Option[Path]
    Definition Classes
    ProcessImplIOE → Process → ProcessLikeConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.Process[O, E]

Inherited from Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplO.html b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplO.html new file mode 100644 index 00000000..ba16d95d --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplO.html @@ -0,0 +1,159 @@ +

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 ProcessImplO[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[[β$10$]ProcessImplOE[O, β$10$]] with Prox.RedirectableInput[ProcessImplIO[O]] with Product with Serializable

Process with bound output streams

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableInput[ProcessImplIO[O]], Prox.RedirectableError[[β$10$]ProcessImplOE[O, β$10$]], Prox.Process[O, Unit], Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessImplO
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableInput
  6. RedirectableError
  7. Process
  8. ProcessConfiguration
  9. ProcessLikeConfiguration
  10. ProcessLike
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessImplO(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 = ProcessImplO[O]
    Definition Classes
    ProcessImplO → Process → ProcessLikeConfiguration

Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): ProcessImplIO[O]

    Feed the process input from a byte stream with flushing per chunks +enabled.

    Feed the process input from a byte stream with flushing per chunks +enabled.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. def !>(path: Path): ProcessImplOE[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
  4. def !>(sink: Prox.ProxSink[Byte]): ProcessImplOE[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
  5. def !>#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplOE[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
  6. def !>>(path: Path): ProcessImplOE[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
  7. def !>?[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplOE[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
  8. final def ##: Int
    Definition Classes
    AnyRef → Any
  9. def <(stream: Prox.ProxStream[Byte]): ProcessImplIO[O]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  10. def <(path: Path): ProcessImplIO[O]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  11. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def appendErrorToFile(path: Path): ProcessImplOE[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
  13. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration → ProcessLikeConfiguration
  14. val arguments: List[String]
    Definition Classes
    ProcessImplO → Process
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. val command: String
    Definition Classes
    ProcessImplO → Process
  18. def connectError[R <: Prox.OutputRedirection, RE](target: R)(implicit outputRedirectionType: Aux[R, RE]): ProcessImplOE[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
    ProcessImplO → RedirectableError
  19. def connectInput(source: Prox.InputRedirection): ProcessImplIO[O]

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience. +

    source

    + Redirection source

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    ProcessImplO → RedirectableInput
  20. def drainError[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplOE[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
  21. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessImplO → Process → ProcessLikeConfiguration
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplO → Process
  24. def errorToFile(path: Path): ProcessImplOE[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
  25. def errorToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): ProcessImplOE[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
  26. def errorToSink(sink: Prox.ProxSink[Byte]): ProcessImplOE[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
  27. def errorToVector[O](pipe: Prox.ProxPipe[Byte, O]): ProcessImplOE[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
  28. def foldError[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessImplOE[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
  29. def fromFile(path: Path): ProcessImplIO[O]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  30. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): ProcessImplIO[O]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<. +

    stream

    + Input stream

    flushChunks

    + Flush the process input stream after each chunk

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  31. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  32. 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
  33. 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
  34. val inputRedirection: Prox.InputRedirection
    Definition Classes
    ProcessImplO → Process
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  39. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplO → Process
  40. def productElementNames: Iterator[String]
    Definition Classes
    Product
  41. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessImplO → Process → ProcessLikeConfiguration
  42. 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
  43. val runErrorStream: (InputStream) => Prox.ProxIO[Unit]
    Definition Classes
    ProcessImplO → Process
  44. val runOutputStream: (InputStream) => Prox.ProxIO[O]
    Definition Classes
    ProcessImplO → Process
  45. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImplO[O]
    Attributes
    protected
    Definition Classes
    ProcessImplO → ProcessConfiguration
  46. 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
  47. 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
  48. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  52. 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
  53. 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
  54. 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
  55. 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
  56. val workingDirectory: Option[Path]
    Definition Classes
    ProcessImplO → Process → ProcessLikeConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableInput[ProcessImplIO[O]]

Inherited from Prox.RedirectableError[[β$10$]ProcessImplOE[O, β$10$]]

Inherited from Prox.Process[O, Unit]

Inherited from Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplOE.html b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplOE.html new file mode 100644 index 00000000..0a5cfed1 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process$$ProcessImplOE.html @@ -0,0 +1,80 @@ +

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 ProcessImplOE[O, E](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[E], inputRedirection: Prox.InputRedirection) extends Prox.Process[O, E] with Prox.RedirectableInput[ProcessImplIOE[O, E]] with Product with Serializable

Process with bound output and error streams

Linear Supertypes
Serializable, Product, Equals, Prox.RedirectableInput[ProcessImplIOE[O, E]], Prox.Process[O, E], Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessImplOE
  2. Serializable
  3. Product
  4. Equals
  5. RedirectableInput
  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 ProcessImplOE(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[E], inputRedirection: Prox.InputRedirection)

Type Members

  1. type Self = ProcessImplOE[O, E]
    Definition Classes
    ProcessImplOE → Process → ProcessLikeConfiguration

Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): ProcessImplIOE[O, E]

    Feed the process input from a byte stream with flushing per chunks +enabled.

    Feed the process input from a byte stream with flushing per chunks +enabled.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. def <(stream: Prox.ProxStream[Byte]): ProcessImplIOE[O, E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  5. def <(path: Path): ProcessImplIOE[O, E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration → ProcessLikeConfiguration
  8. val arguments: List[String]
    Definition Classes
    ProcessImplOE → Process
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. val command: String
    Definition Classes
    ProcessImplOE → Process
  12. def connectInput(source: Prox.InputRedirection): ProcessImplIOE[O, E]

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience. +

    source

    + Redirection source

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    ProcessImplOE → RedirectableInput
  13. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessImplOE → Process → ProcessLikeConfiguration
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplOE → Process
  16. def fromFile(path: Path): ProcessImplIOE[O, E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  17. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): ProcessImplIOE[O, E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<. +

    stream

    + Input stream

    flushChunks

    + Flush the process input stream after each chunk

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

    Definition Classes
    RedirectableInput
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. 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
  20. 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
  21. val inputRedirection: Prox.InputRedirection
    Definition Classes
    ProcessImplOE → Process
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  26. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplOE → Process
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessImplOE → Process → ProcessLikeConfiguration
  29. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.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 +

    runner

    + The process runner to be used

    returns

    + the result of the finished process

    Definition Classes
    Process
  30. val runErrorStream: (InputStream) => Prox.ProxIO[E]
    Definition Classes
    ProcessImplOE → Process
  31. val runOutputStream: (InputStream) => Prox.ProxIO[O]
    Definition Classes
    ProcessImplOE → Process
  32. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImplOE[O, E]
    Attributes
    protected
    Definition Classes
    ProcessImplOE → ProcessConfiguration
  33. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.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). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running process

    Definition Classes
    Process
  34. def startProcess[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.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. +

    Info

    + The runner-specific process info type

    runner

    + The process runner to be used

    returns

    + interface for handling the running process

    Definition Classes
    Process
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. 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
  40. 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
  41. 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
  42. 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
  43. val workingDirectory: Option[Path]
    Definition Classes
    ProcessImplOE → Process → ProcessLikeConfiguration

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableInput[ProcessImplIOE[O, E]]

Inherited from Prox.Process[O, E]

Inherited from Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process$.html b/api/io/github/vigoo/prox/ProcessModule$Process$.html new file mode 100644 index 00000000..fe135aa8 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process$.html @@ -0,0 +1,15 @@ +

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
  • Process
  • ProcessConfiguration
  • ProcessResult
  • RunningProcess
  • SimpleProcessResult

object Process

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

Type Members

  1. case class ProcessImpl(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[Unit], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[Unit], inputRedirection: Prox.InputRedirection) extends Prox.Process[Unit, Unit] with Prox.RedirectableOutput[[α$14$]ProcessImplO[α$14$]] with Prox.RedirectableError[[α$15$]ProcessImplE[α$15$]] with Prox.RedirectableInput[ProcessImplI] with Product with Serializable

    Process with no streams bound

  2. case class ProcessImplE[E](command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[Unit], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[E], inputRedirection: Prox.InputRedirection) extends Prox.Process[Unit, E] with Prox.RedirectableInput[ProcessImplIE[E]] with Prox.RedirectableOutput[[α$11$]ProcessImplOE[α$11$, E]] with Product with Serializable

    Process with bound error streams

  3. case class ProcessImplI(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[Unit], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[Unit], inputRedirection: Prox.InputRedirection) extends Prox.Process[Unit, Unit] with Prox.RedirectableOutput[[α$12$]ProcessImplIO[α$12$]] with Prox.RedirectableError[[α$13$]ProcessImplIE[α$13$]] with Product with Serializable

    Process with bound input streams

  4. case class ProcessImplIE[E](command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) => Prox.ProxIO[Unit], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) => Prox.ProxIO[E], inputRedirection: Prox.InputRedirection) extends Prox.Process[Unit, E] with Prox.RedirectableOutput[[α$9$]ProcessImplIOE[α$9$, E]] with Product with Serializable

    Process with bound input and error streams

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

  6. case class ProcessImplIOE[O, E](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[E], inputRedirection: Prox.InputRedirection) extends Prox.Process[O, E] with Product with Serializable

    Process with bound input, output and error streams

  7. case class ProcessImplO[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[[β$10$]ProcessImplOE[O, β$10$]] with Prox.RedirectableInput[ProcessImplIO[O]] with Product with Serializable

    Process with bound output streams

  8. case class ProcessImplOE[O, E](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[E], inputRedirection: Prox.InputRedirection) extends Prox.Process[O, E] with Prox.RedirectableInput[ProcessImplIOE[O, E]] with Product with Serializable

    Process with bound output and error streams

  9. type UnboundEProcess[O] = Prox.Process[O, Unit] with Prox.RedirectableError[[β$1$]Prox.Process[O, β$1$]]

    Process with unbound error stream

  10. type UnboundIEProcess[O] = Prox.Process[O, Unit] with Prox.RedirectableInput[UnboundEProcess[O]] with Prox.RedirectableError[[β$3$]Prox.Process[O, β$3$] with Prox.RedirectableInput[Prox.Process[O, β$3$]]]

    Process with unbound input and error streams

  11. type UnboundIOProcess[E] = Prox.Process[Unit, E] with Prox.RedirectableInput[UnboundOProcess[E]] with Prox.RedirectableOutput[[α$2$]Prox.Process[α$2$, E] with Prox.RedirectableInput[Prox.Process[α$2$, E]]]

    Process with unbound input and output streams

  12. type UnboundIProcess[O, E] = Prox.Process[O, E] with Prox.RedirectableInput[Prox.Process[O, E]]

    Process with unbound input stream

  13. type UnboundOEProcess = Prox.Process[Unit, Unit] with Prox.RedirectableOutput[[α$4$]Prox.Process[α$4$, Unit] with Prox.RedirectableError[[β$1$]Prox.Process[α$4$, β$1$]]] with Prox.RedirectableError[[α$5$]Prox.Process[Unit, α$5$] with Prox.RedirectableOutput[[α$0$]Prox.Process[α$0$, α$5$]]]

    Process with unbound output and error streams

  14. type UnboundOProcess[E] = Prox.Process[Unit, E] with Prox.RedirectableOutput[[α$0$]Prox.Process[α$0$, E]]

    Process with unbound output stream

  15. type UnboundProcess = Prox.Process[Unit, Unit] with Prox.RedirectableInput[UnboundOEProcess] with Prox.RedirectableOutput[[α$6$]Prox.Process[α$6$, Unit] with Prox.RedirectableInput[Prox.Process[α$6$, Unit] with Prox.RedirectableError[[β$1$]Prox.Process[α$6$, β$1$]]] with Prox.RedirectableError[[β$3$]Prox.Process[α$6$, β$3$] with Prox.RedirectableInput[Prox.Process[α$6$, β$3$]]]] with Prox.RedirectableError[[α$7$]Prox.Process[Unit, α$7$] with Prox.RedirectableInput[Prox.Process[Unit, α$7$] with Prox.RedirectableOutput[[α$0$]Prox.Process[α$0$, α$7$]]] with Prox.RedirectableOutput[[α$2$]Prox.Process[α$2$, α$7$] with Prox.RedirectableInput[Prox.Process[α$2$, α$7$]]]]

    Process with unbound input, output and error streams

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(command: String, arguments: List[String] = List.empty): ProcessImpl

    Defines a process to be executed

    Defines a process to be executed

    The process by default uses the standard input, output and error +streams. +

    command

    + Command to be executed

    arguments

    + Arguments for the command

    returns

    + the process specification

  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$Process.html b/api/io/github/vigoo/prox/ProcessModule$Process.html new file mode 100644 index 00000000..c9156870 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$Process.html @@ -0,0 +1,62 @@ +

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
  • Process
  • ProcessConfiguration
  • ProcessResult
  • RunningProcess
  • SimpleProcessResult

trait Process[O, E] extends ProcessLike with Prox.ProcessConfiguration

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

O

+ Output type

E

+ Error output type

Linear Supertypes
Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, 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 <: Prox.Process[O, E]
    Definition Classes
    Process → ProcessLikeConfiguration

Abstract Value Members

  1. abstract val arguments: List[String]
  2. abstract val command: String
  3. abstract val environmentVariables: Map[String, String]
    Definition Classes
    Process → ProcessLikeConfiguration
  4. abstract val errorRedirection: Prox.OutputRedirection
  5. abstract val inputRedirection: Prox.InputRedirection
  6. abstract val outputRedirection: Prox.OutputRedirection
  7. abstract val removedEnvironmentVariables: Set[String]
    Definition Classes
    Process → ProcessLikeConfiguration
  8. abstract val runErrorStream: (InputStream) => Prox.ProxIO[E]
  9. abstract val runOutputStream: (InputStream) => Prox.ProxIO[O]
  10. abstract def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration
  11. 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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. 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
  12. 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
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.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 +

    runner

    + The process runner to be used

    returns

    + the result of the finished process

  18. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.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). +

    runner

    + The process runner to be used

    returns

    + a managed fiber representing the running process

  19. def startProcess[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.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. +

    Info

    + The runner-specific process info type

    runner

    + The process runner to be used

    returns

    + interface for handling the running process

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

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$ProcessConfiguration.html b/api/io/github/vigoo/prox/ProcessModule$ProcessConfiguration.html new file mode 100644 index 00000000..34494ffa --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$ProcessConfiguration.html @@ -0,0 +1,35 @@ +

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
  • Process
  • ProcessConfiguration
  • ProcessResult
  • RunningProcess
  • SimpleProcessResult
t

io.github.vigoo.prox.ProcessModule

ProcessConfiguration

trait ProcessConfiguration extends Prox.ProcessLikeConfiguration

The capability to configure process execution details +

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

Type Members

  1. abstract type Self <: Prox.ProcessLikeConfiguration
    Definition Classes
    ProcessLikeConfiguration

Abstract Value Members

  1. abstract val environmentVariables: Map[String, String]
    Definition Classes
    ProcessLikeConfiguration
  2. abstract val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessLikeConfiguration
  3. abstract def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Process.Self
    Attributes
    protected
  4. abstract val workingDirectory: Option[Path]
    Definition Classes
    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]): Process.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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def in(workingDirectory: Path): Process.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
  12. def inInheritedWorkingDirectory(): Process.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
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. def with(nameValuePair: (String, String)): Process.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
  23. def withArguments(newArguments: List[String]): Process.Self

    Replaces the arguments +

    Replaces the arguments +

    newArguments

    + new list of arguments

    returns

    + returns a new process specification

  24. def withCommand(newCommand: String): Process.Self

    Replaces the command +

    Replaces the command +

    newCommand

    + new value for the command to be executed

    returns

    + returns a new process specification

  25. def without(name: String): Process.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

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox.ProcessLikeConfiguration

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$ProcessResult.html b/api/io/github/vigoo/prox/ProcessModule$ProcessResult.html new file mode 100644 index 00000000..55dfc7ad --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$ProcessResult.html @@ -0,0 +1,17 @@ +

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
  • Process
  • ProcessConfiguration
  • ProcessResult
  • RunningProcess
  • SimpleProcessResult

trait ProcessResult[+O, +E] extends AnyRef

Result of a finished process +

O

+ Output type

E

+ Error output type

Linear Supertypes
AnyRef, Any
Known Subclasses
SimpleProcessResult
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessResult
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val error: E

    Error output value of the process, depends on what error redirection was +applied +

  2. abstract val exitCode: Prox.ProxExitCode

    The exit code of the process

  3. abstract val output: O

    Output value of the process, depends on what output redirection was +applied +

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$RunningProcess.html b/api/io/github/vigoo/prox/ProcessModule$RunningProcess.html new file mode 100644 index 00000000..92db5e6b --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$RunningProcess.html @@ -0,0 +1,14 @@ +

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
  • Process
  • ProcessConfiguration
  • ProcessResult
  • RunningProcess
  • SimpleProcessResult

trait RunningProcess[O, E, +Info] extends AnyRef

Representation of a running process +

O

+ Output type

E

+ Error output type

Info

+ Runner-specific process information

Linear Supertypes
AnyRef, Any
Known Subclasses
JVMRunningProcess
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RunningProcess
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val info: Info

    Gets the runner-specific process information

  2. abstract def isAlive: Prox.ProxIO[Boolean]

    Checks whether the process is still running

  3. abstract def kill(): Prox.ProxIO[Prox.ProcessResult[O, E]]

    Forced termination of the process.

    Forced termination of the process. Blocks until the process stops.

  4. abstract val runningError: Prox.ProxFiber[E]
  5. abstract val runningInput: Prox.ProxFiber[Unit]
  6. abstract val runningOutput: Prox.ProxFiber[O]
  7. abstract def terminate(): Prox.ProxIO[Prox.ProcessResult[O, E]]

    Normal termination of the process.

    Normal termination of the process. Blocks until the process stops.

  8. abstract def waitForExit(): Prox.ProxIO[Prox.ProcessResult[O, E]]

    Block until the process stops

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def mapInfo[I2](f: (Info) => I2): Prox.RunningProcess[O, E, I2]
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule$SimpleProcessResult.html b/api/io/github/vigoo/prox/ProcessModule$SimpleProcessResult.html new file mode 100644 index 00000000..9e14822c --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule$SimpleProcessResult.html @@ -0,0 +1,18 @@ +

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
  • Process
  • ProcessConfiguration
  • ProcessResult
  • RunningProcess
  • SimpleProcessResult
c

io.github.vigoo.prox.ProcessModule

SimpleProcessResult

case class SimpleProcessResult[+O, +E](exitCode: Prox.ProxExitCode, output: O, error: E) extends Prox.ProcessResult[O, E] with Product with Serializable

Default implementation of ProcessResult

Linear Supertypes
Serializable, Product, Equals, Prox.ProcessResult[O, E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleProcessResult
  2. Serializable
  3. Product
  4. Equals
  5. ProcessResult
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SimpleProcessResult(exitCode: Prox.ProxExitCode, output: O, error: E)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val error: E

    Error output value of the process, depends on what error redirection was +applied +

    Error output value of the process, depends on what error redirection was +applied +

    Definition Classes
    SimpleProcessResult → ProcessResult
  8. val exitCode: Prox.ProxExitCode

    The exit code of the process

    The exit code of the process

    Definition Classes
    SimpleProcessResult → ProcessResult
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. val output: O

    Output value of the process, depends on what output redirection was +applied +

    Output value of the process, depends on what output redirection was +applied +

    Definition Classes
    SimpleProcessResult → ProcessResult
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.ProcessResult[O, E]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessModule.html b/api/io/github/vigoo/prox/ProcessModule.html new file mode 100644 index 00000000..a547c6b4 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessModule.html @@ -0,0 +1,29 @@ +

Packages

t

io.github.vigoo.prox

ProcessModule

trait ProcessModule extends AnyRef

Self Type
Prox
Linear Supertypes
AnyRef, Any
Known Subclasses
Prox, ProxFS2, ProxZStream, zstream
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessModule
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait Process[O, E] extends ProcessLike with Prox.ProcessConfiguration

    Describes a system process to be executed

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

    O

    + Output type

    E

    + Error output type

  2. trait ProcessConfiguration extends Prox.ProcessLikeConfiguration

    The capability to configure process execution details +

  3. trait ProcessResult[+O, +E] extends AnyRef

    Result of a finished process +

    Result of a finished process +

    O

    + Output type

    E

    + Error output type

  4. trait RunningProcess[O, E, +Info] extends AnyRef

    Representation of a running process +

    Representation of a running process +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific process information

  5. case class SimpleProcessResult[+O, +E](exitCode: Prox.ProxExitCode, output: O, error: E) extends Prox.ProcessResult[O, E] with Product with Serializable

    Default implementation of ProcessResult

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. object Process

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessInfo.html b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessInfo.html new file mode 100644 index 00000000..2adb3500 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessInfo.html @@ -0,0 +1,10 @@ +

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 ProcessRunnerModule extends AnyRef
    Definition Classes
    prox
  • JVMProcessInfo
  • JVMProcessRunner
  • JVMProcessRunnerBase
  • JVMRunningProcess
  • JVMRunningProcessGroup
  • ProcessRunner

class JVMProcessInfo extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
JVM9ProcessInfo
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JVMProcessInfo
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JVMProcessInfo()

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessRunner.html b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessRunner.html new file mode 100644 index 00000000..8760a5d8 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessRunner.html @@ -0,0 +1,40 @@ +

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 ProcessRunnerModule extends AnyRef
    Definition Classes
    prox
  • JVMProcessInfo
  • JVMProcessRunner
  • JVMProcessRunnerBase
  • JVMRunningProcess
  • JVMRunningProcessGroup
  • ProcessRunner

class JVMProcessRunner extends Prox.JVMProcessRunnerBase[Prox.JVMProcessInfo]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JVMProcessRunner
  2. JVMProcessRunnerBase
  3. ProcessRunner
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JVMProcessRunner()

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def getProcessInfo(process: Process): Prox.ProxIO[Prox.JVMProcessInfo]
    Attributes
    protected
    Definition Classes
    JVMProcessRunner → JVMProcessRunnerBase
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. def start[O, E](processGroup: Prox.ProcessGroup[O, E]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[O, E]]]

    Starts the process group asynchronously and returns a managed fiber +representing it

    Starts the process group asynchronously and returns a managed fiber +representing it

    Joining the fiber means waiting until the process gets terminated. +Cancelling the fiber terminates the process. +

    O

    + Output type

    E

    + Error output type

    processGroup

    + The process group to be started

    returns

    + interface for handling the running process

    Definition Classes
    ProcessRunner
  16. def start[O, E](process: Prox.Process[O, E]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessResult[O, E]]]

    Starts the process asynchronously and returns a managed fiber +representing it

    Starts the process asynchronously and returns a managed fiber +representing it

    Joining the fiber means waiting until the process gets terminated. +Cancelling the fiber terminates the process. +

    O

    + Output type

    E

    + Error output type

    process

    + The process to be started

    returns

    + interface for handling the running process

    Definition Classes
    ProcessRunner
  17. def startProcess[O, E](process: Prox.Process[O, E]): Prox.ProxIO[Prox.RunningProcess[O, E, Prox.JVMProcessInfo]]

    Starts the process asynchronously and returns the RunningProcess +interface for it +

    Starts the process asynchronously and returns the RunningProcess +interface for it +

    O

    + Output type

    E

    + Error output type

    process

    + The process to be started

    returns

    + interface for handling the running process

    Definition Classes
    JVMProcessRunnerBase → ProcessRunner
  18. def startProcessGroup[O, E](processGroup: Prox.ProcessGroup[O, E]): Prox.ProxIO[Prox.RunningProcessGroup[O, E, Prox.JVMProcessInfo]]

    Starts a process group asynchronously and returns an interface for them +

    Starts a process group asynchronously and returns an interface for them +

    O

    + Output type

    E

    + Error output type

    processGroup

    + The process group to start

    returns

    + interface for handling the running process group

    Definition Classes
    JVMProcessRunnerBase → ProcessRunner
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox.JVMProcessRunnerBase[Prox.JVMProcessInfo]

Inherited from Prox.ProcessRunner[Prox.JVMProcessInfo]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessRunnerBase$.html b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessRunnerBase$.html new file mode 100644 index 00000000..11994f4c --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessRunnerBase$.html @@ -0,0 +1,10 @@ +

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 ProcessRunnerModule extends AnyRef
    Definition Classes
    prox
  • JVMProcessInfo
  • JVMProcessRunner
  • JVMProcessRunnerBase
  • JVMRunningProcess
  • JVMRunningProcessGroup
  • ProcessRunner

object JVMProcessRunnerBase

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

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def inputRedirectionToNative(inputRedirection: Prox.InputRedirection): Redirect
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. def ouptutRedirectionToNative(outputRedirection: Prox.OutputRedirection): Redirect
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. def withEnvironmentVariables[O, E](process: Prox.Process[O, E], builder: ProcessBuilder): ProcessBuilder
  22. def withWorkingDirectory[O, E](process: Prox.Process[O, E], builder: ProcessBuilder): ProcessBuilder

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessRunnerBase.html b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessRunnerBase.html new file mode 100644 index 00000000..6e904c62 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMProcessRunnerBase.html @@ -0,0 +1,40 @@ +

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 ProcessRunnerModule extends AnyRef
    Definition Classes
    prox
  • JVMProcessInfo
  • JVMProcessRunner
  • JVMProcessRunnerBase
  • JVMRunningProcess
  • JVMRunningProcessGroup
  • ProcessRunner

abstract class JVMProcessRunnerBase[Info <: Prox.JVMProcessInfo] extends Prox.ProcessRunner[Info]

Default implementation of ProcessRunner using the Java process API

Linear Supertypes
Prox.ProcessRunner[Info], AnyRef, Any
Known Subclasses
JVMProcessRunner, JVM9ProcessRunner
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JVMProcessRunnerBase
  2. ProcessRunner
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JVMProcessRunnerBase()

Abstract Value Members

  1. abstract def getProcessInfo(process: Process): Prox.ProxIO[Info]
    Attributes
    protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. def start[O, E](processGroup: Prox.ProcessGroup[O, E]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[O, E]]]

    Starts the process group asynchronously and returns a managed fiber +representing it

    Starts the process group asynchronously and returns a managed fiber +representing it

    Joining the fiber means waiting until the process gets terminated. +Cancelling the fiber terminates the process. +

    O

    + Output type

    E

    + Error output type

    processGroup

    + The process group to be started

    returns

    + interface for handling the running process

    Definition Classes
    ProcessRunner
  15. def start[O, E](process: Prox.Process[O, E]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessResult[O, E]]]

    Starts the process asynchronously and returns a managed fiber +representing it

    Starts the process asynchronously and returns a managed fiber +representing it

    Joining the fiber means waiting until the process gets terminated. +Cancelling the fiber terminates the process. +

    O

    + Output type

    E

    + Error output type

    process

    + The process to be started

    returns

    + interface for handling the running process

    Definition Classes
    ProcessRunner
  16. def startProcess[O, E](process: Prox.Process[O, E]): Prox.ProxIO[Prox.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 +

    O

    + Output type

    E

    + Error output type

    process

    + The process to be started

    returns

    + interface for handling the running process

    Definition Classes
    JVMProcessRunnerBase → ProcessRunner
  17. def startProcessGroup[O, E](processGroup: Prox.ProcessGroup[O, E]): Prox.ProxIO[Prox.RunningProcessGroup[O, E, Info]]

    Starts a process group asynchronously and returns an interface for them +

    Starts a process group asynchronously and returns an interface for them +

    O

    + Output type

    E

    + Error output type

    processGroup

    + The process group to start

    returns

    + interface for handling the running process group

    Definition Classes
    JVMProcessRunnerBase → ProcessRunner
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox.ProcessRunner[Info]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessRunnerModule$JVMRunningProcess.html b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMRunningProcess.html new file mode 100644 index 00000000..5e9f8aa9 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMRunningProcess.html @@ -0,0 +1,10 @@ +

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 ProcessRunnerModule extends AnyRef
    Definition Classes
    prox
  • JVMProcessInfo
  • JVMProcessRunner
  • JVMProcessRunnerBase
  • JVMRunningProcess
  • JVMRunningProcessGroup
  • ProcessRunner

class JVMRunningProcess[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcess[O, E, Info]

Default implementation of RunningProcess using the Java process API

Linear Supertypes
Prox.RunningProcess[O, E, Info], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JVMRunningProcess
  2. RunningProcess
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JVMRunningProcess(nativeProcess: Process, runningInput: Prox.ProxFiber[Unit], runningOutput: Prox.ProxFiber[O], runningError: Prox.ProxFiber[E], info: Info)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. val info: Info

    Gets the runner-specific process information

    Gets the runner-specific process information

    Definition Classes
    JVMRunningProcess → RunningProcess
  11. def isAlive: Prox.ProxIO[Boolean]

    Checks whether the process is still running

    Checks whether the process is still running

    Definition Classes
    JVMRunningProcess → RunningProcess
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def kill(): Prox.ProxIO[Prox.ProcessResult[O, E]]

    Forced termination of the process.

    Forced termination of the process. Blocks until the process stops.

    Definition Classes
    JVMRunningProcess → RunningProcess
  14. def mapInfo[I2](f: (Info) => I2): Prox.RunningProcess[O, E, I2]
    Definition Classes
    RunningProcess
  15. val nativeProcess: Process
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. val runningError: Prox.ProxFiber[E]
    Definition Classes
    JVMRunningProcess → RunningProcess
  20. val runningInput: Prox.ProxFiber[Unit]
    Definition Classes
    JVMRunningProcess → RunningProcess
  21. val runningOutput: Prox.ProxFiber[O]
    Definition Classes
    JVMRunningProcess → RunningProcess
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def terminate(): Prox.ProxIO[Prox.ProcessResult[O, E]]

    Normal termination of the process.

    Normal termination of the process. Blocks until the process stops.

    Definition Classes
    JVMRunningProcess → RunningProcess
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. def waitForExit(): Prox.ProxIO[Prox.ProcessResult[O, E]]

    Block until the process stops

    Block until the process stops

    Definition Classes
    JVMRunningProcess → RunningProcess

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox.RunningProcess[O, E, Info]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessRunnerModule$JVMRunningProcessGroup.html b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMRunningProcessGroup.html new file mode 100644 index 00000000..48c7b42e --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessRunnerModule$JVMRunningProcessGroup.html @@ -0,0 +1,13 @@ +

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 ProcessRunnerModule extends AnyRef
    Definition Classes
    prox
  • JVMProcessInfo
  • JVMProcessRunner
  • JVMProcessRunnerBase
  • JVMRunningProcess
  • JVMRunningProcessGroup
  • ProcessRunner
c

io.github.vigoo.prox.ProcessRunnerModule

JVMRunningProcessGroup

class JVMRunningProcessGroup[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcessGroup[O, E, Info]

Default implementation of RunningProcessGroup using the Java process +API +

Linear Supertypes
Prox.RunningProcessGroup[O, E, Info], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JVMRunningProcessGroup
  2. RunningProcessGroup
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JVMRunningProcessGroup(runningProcesses: Map[Prox.Process[Unit, Unit], Prox.RunningProcess[_, E, Info]], runningOutput: Prox.ProxFiber[O])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. val info: Map[Prox.Process[Unit, Unit], Info]

    Runner-specific information about each running process

    Runner-specific information about each running process

    Definition Classes
    JVMRunningProcessGroup → RunningProcessGroup
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def kill(): Prox.ProxIO[Prox.ProcessGroupResult[O, E]]

    Forcibly terminates all processes in the group.

    Forcibly terminates all processes in the group. Blocks until it is done. +

    Definition Classes
    JVMRunningProcessGroup → RunningProcessGroup
  13. def mapInfo[I2](f: (Prox.Process[Unit, Unit], Info) => I2): Prox.RunningProcessGroup[O, E, I2]
    Definition Classes
    RunningProcessGroup
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. val runningOutput: Prox.ProxFiber[O]
    Definition Classes
    JVMRunningProcessGroup → RunningProcessGroup
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def terminate(): Prox.ProxIO[Prox.ProcessGroupResult[O, E]]

    Terminates all processes in the group.

    Terminates all processes in the group. Blocks until it is done.

    Definition Classes
    JVMRunningProcessGroup → RunningProcessGroup
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. def waitForExit(): Prox.ProxIO[Prox.ProcessGroupResult[O, E]]

    Blocks until the processes finish running

    Blocks until the processes finish running

    Definition Classes
    JVMRunningProcessGroup → RunningProcessGroup

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox.RunningProcessGroup[O, E, Info]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessRunnerModule$ProcessRunner.html b/api/io/github/vigoo/prox/ProcessRunnerModule$ProcessRunner.html new file mode 100644 index 00000000..5f3bf1b2 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessRunnerModule$ProcessRunner.html @@ -0,0 +1,42 @@ +

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 ProcessRunnerModule extends AnyRef
    Definition Classes
    prox
  • JVMProcessInfo
  • JVMProcessRunner
  • JVMProcessRunnerBase
  • JVMRunningProcess
  • JVMRunningProcessGroup
  • ProcessRunner

trait ProcessRunner[Info] extends AnyRef

Interface for running processes and process groups

The default implementation is JVMProcessRunner +

Info

+ The type of information provided for a started process

Linear Supertypes
AnyRef, Any
Known Subclasses
JVMProcessRunner, JVMProcessRunnerBase, JVM9ProcessRunner
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessRunner
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def startProcess[O, E](process: Prox.Process[O, E]): Prox.ProxIO[Prox.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 +

    O

    + Output type

    E

    + Error output type

    process

    + The process to be started

    returns

    + interface for handling the running process

  2. abstract def startProcessGroup[O, E](processGroup: Prox.ProcessGroup[O, E]): Prox.ProxIO[Prox.RunningProcessGroup[O, E, Info]]

    Starts a process group asynchronously and returns an interface for them +

    Starts a process group asynchronously and returns an interface for them +

    O

    + Output type

    E

    + Error output type

    processGroup

    + The process group to start

    returns

    + interface for handling the running process group

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. def start[O, E](processGroup: Prox.ProcessGroup[O, E]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessGroupResult[O, E]]]

    Starts the process group asynchronously and returns a managed fiber +representing it

    Starts the process group asynchronously and returns a managed fiber +representing it

    Joining the fiber means waiting until the process gets terminated. +Cancelling the fiber terminates the process. +

    O

    + Output type

    E

    + Error output type

    processGroup

    + The process group to be started

    returns

    + interface for handling the running process

  15. def start[O, E](process: Prox.Process[O, E]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessResult[O, E]]]

    Starts the process asynchronously and returns a managed fiber +representing it

    Starts the process asynchronously and returns a managed fiber +representing it

    Joining the fiber means waiting until the process gets terminated. +Cancelling the fiber terminates the process. +

    O

    + Output type

    E

    + Error output type

    process

    + The process to be started

    returns

    + interface for handling the running process

  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProcessRunnerModule.html b/api/io/github/vigoo/prox/ProcessRunnerModule.html new file mode 100644 index 00000000..02c84012 --- /dev/null +++ b/api/io/github/vigoo/prox/ProcessRunnerModule.html @@ -0,0 +1,14 @@ +

Packages

t

io.github.vigoo.prox

ProcessRunnerModule

trait ProcessRunnerModule extends AnyRef

Self Type
Prox
Linear Supertypes
AnyRef, Any
Known Subclasses
Prox, ProxFS2, ProxZStream, zstream
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessRunnerModule
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class JVMProcessInfo extends AnyRef
  2. class JVMProcessRunner extends Prox.JVMProcessRunnerBase[Prox.JVMProcessInfo]
  3. abstract class JVMProcessRunnerBase[Info <: Prox.JVMProcessInfo] extends Prox.ProcessRunner[Info]

    Default implementation of ProcessRunner using the Java process API

  4. class JVMRunningProcess[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcess[O, E, Info]

    Default implementation of RunningProcess using the Java process API

  5. class JVMRunningProcessGroup[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcessGroup[O, E, Info]

    Default implementation of RunningProcessGroup using the Java process +API +

  6. trait ProcessRunner[Info] extends AnyRef

    Interface for running processes and process groups

    Interface for running processes and process groups

    The default implementation is JVMProcessRunner +

    Info

    + The type of information provided for a started process

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. object JVMProcessRunnerBase

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxError.html b/api/io/github/vigoo/prox/ProxError.html new file mode 100644 index 00000000..aecbc5e0 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxError.html @@ -0,0 +1,10 @@ +

Packages

sealed trait ProxError extends AnyRef

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProxError
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def toThrowable: Throwable

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxFS2$.html b/api/io/github/vigoo/prox/ProxFS2$.html new file mode 100644 index 00000000..840c50b9 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxFS2$.html @@ -0,0 +1,10 @@ +

Packages

object ProxFS2

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

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[F[_]](implicit a: Async[F]): ProxFS2[F]
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxFS2.html b/api/io/github/vigoo/prox/ProxFS2.html new file mode 100644 index 00000000..bb729138 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxFS2.html @@ -0,0 +1,76 @@ +

Packages

trait ProxFS2[F[_]] extends Prox

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProxFS2
  2. Prox
  3. SyntaxModule
  4. ProcessRunnerModule
  5. RedirectionModule
  6. ProcessGroupModule
  7. ProcessModule
  8. CommonModule
  9. ProxRuntime
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait ProcessLikeConfiguration extends AnyRef
    Definition Classes
    CommonModule
  2. trait ProcessGroup[O, E] extends ProcessLike with Prox.ProcessGroupConfiguration[O, E]

    Process group is two or more processes attached to each other

    Process group is two or more processes attached to each other

    This implements a pipeline of processes. The input of the first process +and the output of the last process is redirectable with the +RedirectableInput and RedirectableOutput traits. The processes are +attached to each other's input/output streams, the pipe between them is +customizable.

    The error streams are also redirectable with the RedirectableErrors +trait. +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessGroupModule
  3. trait ProcessGroupConfiguration[O, E] extends Prox.ProcessLikeConfiguration
    Definition Classes
    ProcessGroupModule
  4. trait ProcessGroupResult[+O, +E] extends AnyRef

    Result of an executed process group +

    Result of an executed process group +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessGroupModule
  5. trait RunningProcessGroup[O, E, +Info] extends AnyRef

    Representation of a running process group +

    Representation of a running process group +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific per-process information type

    Definition Classes
    ProcessGroupModule
  6. case class SimpleProcessGroupResult[+O, +E](exitCodes: Map[Prox.Process[Unit, Unit], Prox.ProxExitCode], output: O, errors: Map[Prox.Process[Unit, Unit], E]) extends Prox.ProcessGroupResult[O, E] with Product with Serializable

    Default implementation of ProcessGroupResult

    Default implementation of ProcessGroupResult

    Definition Classes
    ProcessGroupModule
  7. trait Process[O, E] extends ProcessLike with Prox.ProcessConfiguration

    Describes a system process to be executed

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

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessModule
  8. trait ProcessConfiguration extends Prox.ProcessLikeConfiguration

    The capability to configure process execution details +

    The capability to configure process execution details +

    Definition Classes
    ProcessModule
  9. trait ProcessResult[+O, +E] extends AnyRef

    Result of a finished process +

    Result of a finished process +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessModule
  10. trait RunningProcess[O, E, +Info] extends AnyRef

    Representation of a running process +

    Representation of a running process +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific process information

    Definition Classes
    ProcessModule
  11. case class SimpleProcessResult[+O, +E](exitCode: Prox.ProxExitCode, output: O, error: E) extends Prox.ProcessResult[O, E] with Product with Serializable

    Default implementation of ProcessResult

    Default implementation of ProcessResult

    Definition Classes
    ProcessModule
  12. class JVMProcessInfo extends AnyRef
    Definition Classes
    ProcessRunnerModule
  13. class JVMProcessRunner extends Prox.JVMProcessRunnerBase[Prox.JVMProcessInfo]
    Definition Classes
    ProcessRunnerModule
  14. abstract class JVMProcessRunnerBase[Info <: Prox.JVMProcessInfo] extends Prox.ProcessRunner[Info]

    Default implementation of ProcessRunner using the Java process API

    Default implementation of ProcessRunner using the Java process API

    Definition Classes
    ProcessRunnerModule
  15. class JVMRunningProcess[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcess[O, E, Info]

    Default implementation of RunningProcess using the Java process API

    Default implementation of RunningProcess using the Java process API

    Definition Classes
    ProcessRunnerModule
  16. class JVMRunningProcessGroup[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcessGroup[O, E, Info]

    Default implementation of RunningProcessGroup using the Java process +API +

    Default implementation of RunningProcessGroup using the Java process +API +

    Definition Classes
    ProcessRunnerModule
  17. trait ProcessRunner[Info] extends AnyRef

    Interface for running processes and process groups

    Interface for running processes and process groups

    The default implementation is JVMProcessRunner +

    Info

    + The type of information provided for a started process

    Definition Classes
    ProcessRunnerModule
  18. type ProxExitCode = ExitCode
    Definition Classes
    ProxFS2 → ProxRuntime
  19. type ProxFiber[A] = Fiber[F, Throwable, A]
    Definition Classes
    ProxFS2 → ProxRuntime
  20. type ProxIO[A] = F[A]
    Definition Classes
    ProxFS2 → ProxRuntime
  21. type ProxMonoid[A] = Monoid[A]
    Definition Classes
    ProxFS2 → ProxRuntime
  22. type ProxPipe[A, B] = (Stream[F, A]) => Stream[F, B]
    Definition Classes
    ProxFS2 → ProxRuntime
  23. type ProxResource[A] = Resource[F, A]
    Definition Classes
    ProxFS2 → ProxRuntime
  24. type ProxSink[A] = (Stream[F, A]) => Stream[F, Unit]
    Definition Classes
    ProxFS2 → ProxRuntime
  25. type ProxStream[A] = Stream[F, A]
    Definition Classes
    ProxFS2 → ProxRuntime
  26. implicit class FiberOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  27. implicit class IOOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  28. implicit class ListProxErrorOps extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  29. implicit class MonoidStreamOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  30. implicit class ResourceOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  31. implicit class StreamOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  32. case class AllCapturedThroughPipe[O, OR](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  33. case class AllCapturedToSink(sinkFn: (Prox.Process[_, _]) => Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  34. case class AllToFile(pathFn: (Prox.Process[_, _]) => Path, append: Boolean) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  35. case class AllToStdErr() extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  36. sealed trait GroupErrorRedirection extends AnyRef

    Supported process group error redirection types.

    Supported process group error redirection types. Should not be used +directly, see the redirection traits instead. +

    Definition Classes
    RedirectionModule
  37. trait GroupErrorRedirectionType[R] extends AnyRef

    Helper type class for process group error redirection dependent typing

    Helper type class for process group error redirection dependent typing

    Definition Classes
    RedirectionModule
  38. case class InputFile(path: Path) extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  39. sealed trait InputRedirection extends AnyRef

    Supported input redirection types.

    Supported input redirection types. Should not be used directly, see the +redirection traits instead. +

    Definition Classes
    RedirectionModule
  40. case class InputStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean) extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  41. case class OutputFile(path: Path, append: Boolean) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  42. sealed trait OutputRedirection extends AnyRef

    Supported output redirection types.

    Supported output redirection types. Should not be used directly, see the +redirection traits instead. +

    Definition Classes
    RedirectionModule
  43. trait OutputRedirectionType[R] extends AnyRef

    Helper type class for output and error redirection dependent typing

    Helper type class for output and error redirection dependent typing

    Definition Classes
    RedirectionModule
  44. case class OutputStreamThroughPipe[O, OR](pipe: Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  45. case class OutputStreamToSink(sink: Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  46. trait RedirectableError[+P[_] <: Prox.Process[_, _]] extends AnyRef

    The capability to redirect the error output of a process +

    The capability to redirect the error output of a process +

    P

    + Self type without the RedirectableError capability

    Definition Classes
    RedirectionModule
  47. trait RedirectableErrors[+P[_] <: Prox.ProcessGroup[_, _]] extends AnyRef

    The capability to redirect all the error outputs simultaneously of a +process group +

    The capability to redirect all the error outputs simultaneously of a +process group +

    P

    + Self type without the RedirectableErrors capability

    Definition Classes
    RedirectionModule
  48. trait RedirectableInput[+P <: ProcessLike] extends AnyRef

    The capability to redirect the input of a process or process group +

    The capability to redirect the input of a process or process group +

    Definition Classes
    RedirectionModule
  49. trait RedirectableOutput[+P[_] <: ProcessLike] extends AnyRef

    The capability to redirect the output of a process or a process group +

    The capability to redirect the output of a process or a process group +

    P

    + Self type without the RedirectableOutput capability

    Definition Classes
    RedirectionModule
  50. case class StdIn() extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  51. case class StdOut() extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  52. trait PipeBuilder[P] extends AnyRef
    Definition Classes
    SyntaxModule
  53. class PipeBuilderSyntax[P] extends AnyRef
    Definition Classes
    SyntaxModule
  54. implicit class ProcessPiping extends AnyRef

    Extension methods for unbound processes enabling the creation of process +groups +

    Extension methods for unbound processes enabling the creation of process +groups +

    Definition Classes
    SyntaxModule
  55. implicit class ProcessStringContextIO extends AnyRef

    String interpolator for an alternative of Process.apply

    String interpolator for an alternative of Process.apply

    val process = proc"ls -hal $dir"
    Definition Classes
    SyntaxModule

Abstract Value Members

  1. abstract val instances: Sync[F] with Concurrent[F]

Concrete Value Members

  1. object ProcessGroup
    Definition Classes
    ProcessGroupModule
  2. object Process
    Definition Classes
    ProcessModule
  3. object JVMProcessRunnerBase
    Definition Classes
    ProcessRunnerModule
  4. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. final def blockingEffect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  9. final def bracket[A, B](acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  10. final def cancelFiber[A](f: ProxFiber[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def drainStream[A](s: ProxStream[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  13. final def drainToJavaOutputStream(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  14. final def effect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def exitCodeFromInt(value: Int): ProxExitCode
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  18. final def foldMonoidStream[A](s: ProxStream[A])(implicit arg0: ProxMonoid[A]): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  19. final def foldStream[A, B](s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  20. final def fromJavaInputStream(input: java.io.InputStream, chunkSize: Int): ProxStream[Byte]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  23. final def identityPipe[A]: ProxPipe[A, A]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  24. final def ioFlatMap[A, B](io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  25. final def ioMap[A, B](io: ProxIO[A], f: (A) => B): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def joinFiber[A](f: ProxFiber[A]): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  28. final def makeResource[A](acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  32. final def pure[A](value: A): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  33. final def raiseError(error: ProxError): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  34. final def runStreamTo[A](s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  35. final def startFiber[A](f: ProxIO[A]): ProxIO[ProxFiber[A]]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  36. final def streamThrough[A, B](s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  37. final def streamToVector[A](s: ProxStream[A]): ProxIO[Vector[A]]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def traverse[A, B](list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  41. final def unit: ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  42. final def useResource[A, B](r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxFS2 → ProxRuntime
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. object GroupErrorRedirectionType
    Definition Classes
    RedirectionModule
  47. object OutputRedirectionType
    Definition Classes
    RedirectionModule
  48. object RedirectableErrors
    Definition Classes
    RedirectionModule

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox

Inherited from SyntaxModule

Inherited from ProcessRunnerModule

Inherited from RedirectionModule

Inherited from ProcessGroupModule

Inherited from ProcessModule

Inherited from CommonModule

Inherited from ProxRuntime

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxRuntime$FiberOps.html b/api/io/github/vigoo/prox/ProxRuntime$FiberOps.html new file mode 100644 index 00000000..4cb47539 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxRuntime$FiberOps.html @@ -0,0 +1,10 @@ +

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 ProxRuntime extends AnyRef
    Definition Classes
    prox
  • FiberOps
  • IOOps
  • ListProxErrorOps
  • MonoidStreamOps
  • ProxExitCode
  • ProxFiber
  • ProxIO
  • ProxMonoid
  • ProxPipe
  • ProxResource
  • ProxSink
  • ProxStream
  • ResourceOps
  • StreamOps

implicit class FiberOps[A] extends AnyRef

Attributes
protected
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FiberOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FiberOps(f: ProxFiber[A])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def cancel: ProxIO[Unit]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def join: ProxIO[A]
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxRuntime$IOOps.html b/api/io/github/vigoo/prox/ProxRuntime$IOOps.html new file mode 100644 index 00000000..6371934e --- /dev/null +++ b/api/io/github/vigoo/prox/ProxRuntime$IOOps.html @@ -0,0 +1,10 @@ +

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 ProxRuntime extends AnyRef
    Definition Classes
    prox
  • FiberOps
  • IOOps
  • ListProxErrorOps
  • MonoidStreamOps
  • ProxExitCode
  • ProxFiber
  • ProxIO
  • ProxMonoid
  • ProxPipe
  • ProxResource
  • ProxSink
  • ProxStream
  • ResourceOps
  • StreamOps

implicit class IOOps[A] extends AnyRef

Attributes
protected
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IOOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new IOOps(io: ProxIO[A])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def flatMap[B](f: (A) => ProxIO[B]): ProxIO[B]
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def map[B](f: (A) => B): ProxIO[B]
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxRuntime$ListProxErrorOps.html b/api/io/github/vigoo/prox/ProxRuntime$ListProxErrorOps.html new file mode 100644 index 00000000..e7e352e9 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxRuntime$ListProxErrorOps.html @@ -0,0 +1,10 @@ +

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 ProxRuntime extends AnyRef
    Definition Classes
    prox
  • FiberOps
  • IOOps
  • ListProxErrorOps
  • MonoidStreamOps
  • ProxExitCode
  • ProxFiber
  • ProxIO
  • ProxMonoid
  • ProxPipe
  • ProxResource
  • ProxSink
  • ProxStream
  • ResourceOps
  • StreamOps
c

io.github.vigoo.prox.ProxRuntime

ListProxErrorOps

implicit class ListProxErrorOps extends AnyRef

Attributes
protected
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ListProxErrorOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ListProxErrorOps(list: List[ProxError])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toSingleError: ProxError
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxRuntime$MonoidStreamOps.html b/api/io/github/vigoo/prox/ProxRuntime$MonoidStreamOps.html new file mode 100644 index 00000000..902a1643 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxRuntime$MonoidStreamOps.html @@ -0,0 +1,10 @@ +

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 ProxRuntime extends AnyRef
    Definition Classes
    prox
  • FiberOps
  • IOOps
  • ListProxErrorOps
  • MonoidStreamOps
  • ProxExitCode
  • ProxFiber
  • ProxIO
  • ProxMonoid
  • ProxPipe
  • ProxResource
  • ProxSink
  • ProxStream
  • ResourceOps
  • StreamOps

implicit class MonoidStreamOps[A] extends AnyRef

Attributes
protected
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MonoidStreamOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MonoidStreamOps(s: ProxStream[A])(implicit arg0: ProxMonoid[A])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def foldMonoid: ProxIO[A]
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxRuntime$ResourceOps.html b/api/io/github/vigoo/prox/ProxRuntime$ResourceOps.html new file mode 100644 index 00000000..c37c2ea6 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxRuntime$ResourceOps.html @@ -0,0 +1,10 @@ +

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 ProxRuntime extends AnyRef
    Definition Classes
    prox
  • FiberOps
  • IOOps
  • ListProxErrorOps
  • MonoidStreamOps
  • ProxExitCode
  • ProxFiber
  • ProxIO
  • ProxMonoid
  • ProxPipe
  • ProxResource
  • ProxSink
  • ProxStream
  • ResourceOps
  • StreamOps

implicit class ResourceOps[A] extends AnyRef

Attributes
protected
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResourceOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ResourceOps(r: ProxResource[A])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. def use[B](f: (A) => ProxIO[B]): ProxIO[B]
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxRuntime$StreamOps.html b/api/io/github/vigoo/prox/ProxRuntime$StreamOps.html new file mode 100644 index 00000000..ef44d484 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxRuntime$StreamOps.html @@ -0,0 +1,10 @@ +

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 ProxRuntime extends AnyRef
    Definition Classes
    prox
  • FiberOps
  • IOOps
  • ListProxErrorOps
  • MonoidStreamOps
  • ProxExitCode
  • ProxFiber
  • ProxIO
  • ProxMonoid
  • ProxPipe
  • ProxResource
  • ProxSink
  • ProxStream
  • ResourceOps
  • StreamOps

implicit class StreamOps[A] extends AnyRef

Attributes
protected
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StreamOps(s: ProxStream[A])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. def drain: ProxIO[Unit]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def fold[B](init: B, f: (B, A) => B): ProxIO[B]
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. def run(sink: ProxSink[A]): ProxIO[Unit]
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def through[B](pipe: ProxPipe[A, B]): ProxStream[B]
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. def toVector: ProxIO[Vector[A]]
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxRuntime.html b/api/io/github/vigoo/prox/ProxRuntime.html new file mode 100644 index 00000000..683dc326 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxRuntime.html @@ -0,0 +1,10 @@ +

Packages

t

io.github.vigoo.prox

ProxRuntime

trait ProxRuntime extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Prox, ProxFS2, ProxZStream, zstream
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProxRuntime
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class FiberOps[A] extends AnyRef
    Attributes
    protected
  2. implicit class IOOps[A] extends AnyRef
    Attributes
    protected
  3. implicit class ListProxErrorOps extends AnyRef
    Attributes
    protected
  4. implicit class MonoidStreamOps[A] extends AnyRef
    Attributes
    protected
  5. abstract type ProxExitCode
  6. abstract type ProxFiber[_]
  7. abstract type ProxIO[_]
  8. abstract type ProxMonoid[_]
  9. abstract type ProxPipe[_, _]
  10. abstract type ProxResource[_]
  11. abstract type ProxSink[_]
  12. abstract type ProxStream[_]
  13. implicit class ResourceOps[A] extends AnyRef
    Attributes
    protected
  14. implicit class StreamOps[A] extends AnyRef
    Attributes
    protected

Abstract Value Members

  1. abstract def blockingEffect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
  2. abstract def bracket[A, B](acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]
    Attributes
    protected
  3. abstract def cancelFiber[A](f: ProxFiber[A]): ProxIO[Unit]
    Attributes
    protected
  4. abstract def drainStream[A](s: ProxStream[A]): ProxIO[Unit]
    Attributes
    protected
  5. abstract def drainToJavaOutputStream(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]
    Attributes
    protected
  6. abstract def effect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
  7. abstract def exitCodeFromInt(value: Int): ProxExitCode
    Attributes
    protected
  8. abstract def foldMonoidStream[A](s: ProxStream[A])(implicit arg0: ProxMonoid[A]): ProxIO[A]
    Attributes
    protected
  9. abstract def foldStream[A, B](s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]
    Attributes
    protected
  10. abstract def fromJavaInputStream(input: InputStream, chunkSize: Int): ProxStream[Byte]
    Attributes
    protected
  11. abstract def identityPipe[A]: ProxPipe[A, A]
    Attributes
    protected
  12. abstract def ioFlatMap[A, B](io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected
  13. abstract def ioMap[A, B](io: ProxIO[A], f: (A) => B): ProxIO[B]
    Attributes
    protected
  14. abstract def joinFiber[A](f: ProxFiber[A]): ProxIO[A]
    Attributes
    protected
  15. abstract def makeResource[A](acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]
    Attributes
    protected
  16. abstract def pure[A](value: A): ProxIO[A]
    Attributes
    protected
  17. abstract def raiseError(error: ProxError): ProxIO[Unit]
    Attributes
    protected
  18. abstract def runStreamTo[A](s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]
    Attributes
    protected
  19. abstract def startFiber[A](f: ProxIO[A]): ProxIO[ProxFiber[A]]
    Attributes
    protected
  20. abstract def streamThrough[A, B](s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]
    Attributes
    protected
  21. abstract def streamToVector[A](s: ProxStream[A]): ProxIO[Vector[A]]
    Attributes
    protected
  22. abstract def traverse[A, B](list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]
    Attributes
    protected
  23. abstract def unit: ProxIO[Unit]
    Attributes
    protected
  24. abstract def useResource[A, B](r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxZStream$TransformAndSink$.html b/api/io/github/vigoo/prox/ProxZStream$TransformAndSink$.html new file mode 100644 index 00000000..ad9b86eb --- /dev/null +++ b/api/io/github/vigoo/prox/ProxZStream$TransformAndSink$.html @@ -0,0 +1,10 @@ +

Packages

object TransformAndSink extends Serializable

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransformAndSink
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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[A, B](transducer: ZPipeline[Any, ProxError, A, B], sink: ZSink[Any, ProxError, B, Any, Unit]): TransformAndSink[A, B]
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxZStream$TransformAndSink.html b/api/io/github/vigoo/prox/ProxZStream$TransformAndSink.html new file mode 100644 index 00000000..b86e7903 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxZStream$TransformAndSink.html @@ -0,0 +1,10 @@ +

Packages

case class TransformAndSink[A, B](transform: (ZStream[Any, ProxError, A]) => ZStream[Any, ProxError, B], sink: ZSink[Any, ProxError, B, Any, Unit]) extends Product with Serializable

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransformAndSink
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TransformAndSink(transform: (ZStream[Any, ProxError, A]) => ZStream[Any, ProxError, B], sink: ZSink[Any, ProxError, B, Any, Unit])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. val sink: ZSink[Any, ProxError, B, Any, Unit]
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. val transform: (ZStream[Any, ProxError, A]) => ZStream[Any, ProxError, B]
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/ProxZStream.html b/api/io/github/vigoo/prox/ProxZStream.html new file mode 100644 index 00000000..7c58c6a5 --- /dev/null +++ b/api/io/github/vigoo/prox/ProxZStream.html @@ -0,0 +1,76 @@ +

Packages

t

io.github.vigoo.prox

ProxZStream

trait ProxZStream extends Prox

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProxZStream
  2. Prox
  3. SyntaxModule
  4. ProcessRunnerModule
  5. RedirectionModule
  6. ProcessGroupModule
  7. ProcessModule
  8. CommonModule
  9. ProxRuntime
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait ProcessLikeConfiguration extends AnyRef
    Definition Classes
    CommonModule
  2. trait ProcessGroup[O, E] extends ProcessLike with Prox.ProcessGroupConfiguration[O, E]

    Process group is two or more processes attached to each other

    Process group is two or more processes attached to each other

    This implements a pipeline of processes. The input of the first process +and the output of the last process is redirectable with the +RedirectableInput and RedirectableOutput traits. The processes are +attached to each other's input/output streams, the pipe between them is +customizable.

    The error streams are also redirectable with the RedirectableErrors +trait. +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessGroupModule
  3. trait ProcessGroupConfiguration[O, E] extends Prox.ProcessLikeConfiguration
    Definition Classes
    ProcessGroupModule
  4. trait ProcessGroupResult[+O, +E] extends AnyRef

    Result of an executed process group +

    Result of an executed process group +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessGroupModule
  5. trait RunningProcessGroup[O, E, +Info] extends AnyRef

    Representation of a running process group +

    Representation of a running process group +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific per-process information type

    Definition Classes
    ProcessGroupModule
  6. case class SimpleProcessGroupResult[+O, +E](exitCodes: Map[Prox.Process[Unit, Unit], Prox.ProxExitCode], output: O, errors: Map[Prox.Process[Unit, Unit], E]) extends Prox.ProcessGroupResult[O, E] with Product with Serializable

    Default implementation of ProcessGroupResult

    Default implementation of ProcessGroupResult

    Definition Classes
    ProcessGroupModule
  7. trait Process[O, E] extends ProcessLike with Prox.ProcessConfiguration

    Describes a system process to be executed

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

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessModule
  8. trait ProcessConfiguration extends Prox.ProcessLikeConfiguration

    The capability to configure process execution details +

    The capability to configure process execution details +

    Definition Classes
    ProcessModule
  9. trait ProcessResult[+O, +E] extends AnyRef

    Result of a finished process +

    Result of a finished process +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessModule
  10. trait RunningProcess[O, E, +Info] extends AnyRef

    Representation of a running process +

    Representation of a running process +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific process information

    Definition Classes
    ProcessModule
  11. case class SimpleProcessResult[+O, +E](exitCode: Prox.ProxExitCode, output: O, error: E) extends Prox.ProcessResult[O, E] with Product with Serializable

    Default implementation of ProcessResult

    Default implementation of ProcessResult

    Definition Classes
    ProcessModule
  12. class JVMProcessInfo extends AnyRef
    Definition Classes
    ProcessRunnerModule
  13. class JVMProcessRunner extends Prox.JVMProcessRunnerBase[Prox.JVMProcessInfo]
    Definition Classes
    ProcessRunnerModule
  14. abstract class JVMProcessRunnerBase[Info <: Prox.JVMProcessInfo] extends Prox.ProcessRunner[Info]

    Default implementation of ProcessRunner using the Java process API

    Default implementation of ProcessRunner using the Java process API

    Definition Classes
    ProcessRunnerModule
  15. class JVMRunningProcess[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcess[O, E, Info]

    Default implementation of RunningProcess using the Java process API

    Default implementation of RunningProcess using the Java process API

    Definition Classes
    ProcessRunnerModule
  16. class JVMRunningProcessGroup[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcessGroup[O, E, Info]

    Default implementation of RunningProcessGroup using the Java process +API +

    Default implementation of RunningProcessGroup using the Java process +API +

    Definition Classes
    ProcessRunnerModule
  17. trait ProcessRunner[Info] extends AnyRef

    Interface for running processes and process groups

    Interface for running processes and process groups

    The default implementation is JVMProcessRunner +

    Info

    + The type of information provided for a started process

    Definition Classes
    ProcessRunnerModule
  18. implicit class FiberOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  19. implicit class IOOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  20. implicit class ListProxErrorOps extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  21. implicit class MonoidStreamOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  22. implicit class ResourceOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  23. implicit class StreamOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  24. type ProxExitCode = ExitCode
    Definition Classes
    ProxZStream → ProxRuntime
  25. type ProxFiber[A] = Fiber[ProxError, A]
    Definition Classes
    ProxZStream → ProxRuntime
  26. type ProxIO[A] = ZIO[Any, ProxError, A]
    Definition Classes
    ProxZStream → ProxRuntime
  27. type ProxMonoid[A] = Identity[A]
    Definition Classes
    ProxZStream → ProxRuntime
  28. type ProxPipe[A, B] = (ProxStream[A]) => ProxStream[B]
    Definition Classes
    ProxZStream → ProxRuntime
  29. type ProxResource[A] = ZIO[Scope, ProxError, A]
    Definition Classes
    ProxZStream → ProxRuntime
  30. type ProxSink[A] = TransformAndSink[A, _]
    Definition Classes
    ProxZStream → ProxRuntime
  31. type ProxStream[A] = ZStream[Any, ProxError, A]
    Definition Classes
    ProxZStream → ProxRuntime
  32. case class TransformAndSink[A, B](transform: (ZStream[Any, ProxError, A]) => ZStream[Any, ProxError, B], sink: ZSink[Any, ProxError, B, Any, Unit]) extends Product with Serializable
  33. case class AllCapturedThroughPipe[O, OR](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  34. case class AllCapturedToSink(sinkFn: (Prox.Process[_, _]) => Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  35. case class AllToFile(pathFn: (Prox.Process[_, _]) => Path, append: Boolean) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  36. case class AllToStdErr() extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  37. sealed trait GroupErrorRedirection extends AnyRef

    Supported process group error redirection types.

    Supported process group error redirection types. Should not be used +directly, see the redirection traits instead. +

    Definition Classes
    RedirectionModule
  38. trait GroupErrorRedirectionType[R] extends AnyRef

    Helper type class for process group error redirection dependent typing

    Helper type class for process group error redirection dependent typing

    Definition Classes
    RedirectionModule
  39. case class InputFile(path: Path) extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  40. sealed trait InputRedirection extends AnyRef

    Supported input redirection types.

    Supported input redirection types. Should not be used directly, see the +redirection traits instead. +

    Definition Classes
    RedirectionModule
  41. case class InputStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean) extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  42. case class OutputFile(path: Path, append: Boolean) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  43. sealed trait OutputRedirection extends AnyRef

    Supported output redirection types.

    Supported output redirection types. Should not be used directly, see the +redirection traits instead. +

    Definition Classes
    RedirectionModule
  44. trait OutputRedirectionType[R] extends AnyRef

    Helper type class for output and error redirection dependent typing

    Helper type class for output and error redirection dependent typing

    Definition Classes
    RedirectionModule
  45. case class OutputStreamThroughPipe[O, OR](pipe: Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  46. case class OutputStreamToSink(sink: Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  47. trait RedirectableError[+P[_] <: Prox.Process[_, _]] extends AnyRef

    The capability to redirect the error output of a process +

    The capability to redirect the error output of a process +

    P

    + Self type without the RedirectableError capability

    Definition Classes
    RedirectionModule
  48. trait RedirectableErrors[+P[_] <: Prox.ProcessGroup[_, _]] extends AnyRef

    The capability to redirect all the error outputs simultaneously of a +process group +

    The capability to redirect all the error outputs simultaneously of a +process group +

    P

    + Self type without the RedirectableErrors capability

    Definition Classes
    RedirectionModule
  49. trait RedirectableInput[+P <: ProcessLike] extends AnyRef

    The capability to redirect the input of a process or process group +

    The capability to redirect the input of a process or process group +

    Definition Classes
    RedirectionModule
  50. trait RedirectableOutput[+P[_] <: ProcessLike] extends AnyRef

    The capability to redirect the output of a process or a process group +

    The capability to redirect the output of a process or a process group +

    P

    + Self type without the RedirectableOutput capability

    Definition Classes
    RedirectionModule
  51. case class StdIn() extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  52. case class StdOut() extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  53. trait PipeBuilder[P] extends AnyRef
    Definition Classes
    SyntaxModule
  54. class PipeBuilderSyntax[P] extends AnyRef
    Definition Classes
    SyntaxModule
  55. implicit class ProcessPiping extends AnyRef

    Extension methods for unbound processes enabling the creation of process +groups +

    Extension methods for unbound processes enabling the creation of process +groups +

    Definition Classes
    SyntaxModule
  56. implicit class ProcessStringContextIO extends AnyRef

    String interpolator for an alternative of Process.apply

    String interpolator for an alternative of Process.apply

    val process = proc"ls -hal $dir"
    Definition Classes
    SyntaxModule

Value Members

  1. object ProcessGroup
    Definition Classes
    ProcessGroupModule
  2. object Process
    Definition Classes
    ProcessModule
  3. object JVMProcessRunnerBase
    Definition Classes
    ProcessRunnerModule
  4. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. final def blockingEffect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  9. final def bracket[A, B](acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  10. final def cancelFiber[A](f: ProxFiber[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def drainStream[A](s: ProxStream[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  13. final def drainToJavaOutputStream(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  14. final def effect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def exitCodeFromInt(value: Int): ProxExitCode
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  18. final def foldMonoidStream[A](s: ProxStream[A])(implicit arg0: Identity[A]): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  19. final def foldStream[A, B](s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  20. final def fromJavaInputStream(input: java.io.InputStream, chunkSize: Int): ProxStream[Byte]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  23. final def identityPipe[A]: ProxPipe[A, A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  24. final def ioFlatMap[A, B](io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  25. final def ioMap[A, B](io: ProxIO[A], f: (A) => B): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def joinFiber[A](f: ProxFiber[A]): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  28. final def makeResource[A](acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  32. final def pure[A](value: A): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  33. final def raiseError(error: ProxError): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  34. final def runStreamTo[A](s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  35. implicit def sinkAsTransformAndSink[A](sink: ZSink[Any, ProxError, A, Any, Unit]): TransformAndSink[A, A]
  36. final def startFiber[A](f: ProxIO[A]): ProxIO[ProxFiber[A]]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  37. final def streamThrough[A, B](s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  38. final def streamToVector[A](s: ProxStream[A]): ProxIO[Vector[A]]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. implicit def transducerAsPipe[A, B](transducer: ZPipeline[Any, ProxError, A, B]): ProxPipe[A, B]
  42. implicit def transducerAsPipeThrowable[A, B](transducer: ZPipeline[Any, Throwable, A, B]): ProxPipe[A, B]
  43. final def traverse[A, B](list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  44. final def unit: ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  45. final def useResource[A, B](r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. object TransformAndSink extends Serializable
  50. object GroupErrorRedirectionType
    Definition Classes
    RedirectionModule
  51. object OutputRedirectionType
    Definition Classes
    RedirectionModule
  52. object RedirectableErrors
    Definition Classes
    RedirectionModule

Deprecated Value Members

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

    (Since version 9)

Inherited from Prox

Inherited from SyntaxModule

Inherited from ProcessRunnerModule

Inherited from RedirectionModule

Inherited from ProcessGroupModule

Inherited from ProcessModule

Inherited from CommonModule

Inherited from ProxRuntime

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$AllCapturedThroughPipe.html b/api/io/github/vigoo/prox/RedirectionModule$AllCapturedThroughPipe.html new file mode 100644 index 00000000..d7d2fde6 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$AllCapturedThroughPipe.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox.RedirectionModule

AllCapturedThroughPipe

case class AllCapturedThroughPipe[O, OR](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.GroupErrorRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AllCapturedThroughPipe
  2. Serializable
  3. Product
  4. Equals
  5. GroupErrorRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AllCapturedThroughPipe(pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val chunkSize: Int
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. val pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O]
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. val runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR]
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.GroupErrorRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$AllCapturedToSink.html b/api/io/github/vigoo/prox/RedirectionModule$AllCapturedToSink.html new file mode 100644 index 00000000..da2e14da --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$AllCapturedToSink.html @@ -0,0 +1,10 @@ +

Packages

case class AllCapturedToSink(sinkFn: (Prox.Process[_, _]) => Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.GroupErrorRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AllCapturedToSink
  2. Serializable
  3. Product
  4. Equals
  5. GroupErrorRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AllCapturedToSink(sinkFn: (Prox.Process[_, _]) => Prox.ProxSink[Byte], chunkSize: Int = 8192)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val chunkSize: Int
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. val sinkFn: (Prox.Process[_, _]) => Prox.ProxSink[Byte]
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.GroupErrorRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$AllToFile.html b/api/io/github/vigoo/prox/RedirectionModule$AllToFile.html new file mode 100644 index 00000000..7a1d6288 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$AllToFile.html @@ -0,0 +1,10 @@ +

Packages

case class AllToFile(pathFn: (Prox.Process[_, _]) => Path, append: Boolean) extends Prox.GroupErrorRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.GroupErrorRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AllToFile
  2. Serializable
  3. Product
  4. Equals
  5. GroupErrorRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AllToFile(pathFn: (Prox.Process[_, _]) => Path, append: Boolean)

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. val append: Boolean
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. val pathFn: (Prox.Process[_, _]) => Path
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.GroupErrorRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$AllToStdErr.html b/api/io/github/vigoo/prox/RedirectionModule$AllToStdErr.html new file mode 100644 index 00000000..293b577e --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$AllToStdErr.html @@ -0,0 +1,10 @@ +

Packages

case class AllToStdErr() extends Prox.GroupErrorRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.GroupErrorRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AllToStdErr
  2. Serializable
  3. Product
  4. Equals
  5. GroupErrorRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AllToStdErr()

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  14. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  15. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  16. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.GroupErrorRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$GroupErrorRedirection.html b/api/io/github/vigoo/prox/RedirectionModule$GroupErrorRedirection.html new file mode 100644 index 00000000..90215c55 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$GroupErrorRedirection.html @@ -0,0 +1,12 @@ +

Packages

t

io.github.vigoo.prox.RedirectionModule

GroupErrorRedirection

sealed trait GroupErrorRedirection extends AnyRef

Supported process group error redirection types. Should not be used +directly, see the redirection traits instead. +

Linear Supertypes
AnyRef, Any
Known Subclasses
AllCapturedThroughPipe, AllCapturedToSink, AllToFile, AllToStdErr
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GroupErrorRedirection
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$GroupErrorRedirectionType$.html b/api/io/github/vigoo/prox/RedirectionModule$GroupErrorRedirectionType$.html new file mode 100644 index 00000000..c588e477 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$GroupErrorRedirectionType$.html @@ -0,0 +1,10 @@ +

Packages

object GroupErrorRedirectionType

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

Type Members

  1. type Aux[R, OR, O] = Prox.GroupErrorRedirectionType[R] { ... /* 2 definitions in type refinement */ }

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. implicit def groupErrorRedirectionTypeOfFile: Aux[Prox.AllToFile, Prox.OutputFile, Unit]
  10. implicit def groupErrorRedirectionTypeOfStdErr: Aux[Prox.AllToStdErr, Prox.StdOut, Unit]
  11. implicit def groupErrorRedirectionTypeOfStreamThroughPipe[O, OR]: Aux[Prox.AllCapturedThroughPipe[O, OR], Prox.OutputStreamThroughPipe[O, OR], OR]
  12. implicit val groupErrorRedirectionTypeOfStreamToSink: Aux[Prox.AllCapturedToSink, Prox.OutputStreamToSink, Unit]
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  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
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$GroupErrorRedirectionType.html b/api/io/github/vigoo/prox/RedirectionModule$GroupErrorRedirectionType.html new file mode 100644 index 00000000..9cdc0bbf --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$GroupErrorRedirectionType.html @@ -0,0 +1,10 @@ +

Packages

trait GroupErrorRedirectionType[R] extends AnyRef

Helper type class for process group error redirection dependent typing

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

Type Members

  1. abstract type Out
  2. abstract type OutputR <: Prox.OutputRedirection

Abstract Value Members

  1. abstract def toOutputRedirectionType(redir: R, process: Prox.Process[_, _]): OutputR

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$InputFile.html b/api/io/github/vigoo/prox/RedirectionModule$InputFile.html new file mode 100644 index 00000000..4a6d2d6b --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$InputFile.html @@ -0,0 +1,10 @@ +

Packages

case class InputFile(path: Path) extends Prox.InputRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.InputRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InputFile
  2. Serializable
  3. Product
  4. Equals
  5. InputRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new InputFile(path: Path)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. val path: Path
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.InputRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$InputRedirection.html b/api/io/github/vigoo/prox/RedirectionModule$InputRedirection.html new file mode 100644 index 00000000..be812e25 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$InputRedirection.html @@ -0,0 +1,12 @@ +

Packages

sealed trait InputRedirection extends AnyRef

Supported input redirection types. Should not be used directly, see the +redirection traits instead. +

Linear Supertypes
AnyRef, Any
Known Subclasses
InputFile, InputStream, StdIn
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InputRedirection
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$InputStream.html b/api/io/github/vigoo/prox/RedirectionModule$InputStream.html new file mode 100644 index 00000000..5f8cb0ea --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$InputStream.html @@ -0,0 +1,10 @@ +

Packages

case class InputStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean) extends Prox.InputRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.InputRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InputStream
  2. Serializable
  3. Product
  4. Equals
  5. InputRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new InputStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val flushChunks: Boolean
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. val stream: Prox.ProxStream[Byte]
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.InputRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$OutputFile.html b/api/io/github/vigoo/prox/RedirectionModule$OutputFile.html new file mode 100644 index 00000000..5a5c5333 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$OutputFile.html @@ -0,0 +1,10 @@ +

Packages

case class OutputFile(path: Path, append: Boolean) extends Prox.OutputRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.OutputRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OutputFile
  2. Serializable
  3. Product
  4. Equals
  5. OutputRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new OutputFile(path: Path, append: Boolean)

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. val append: Boolean
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. val path: Path
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.OutputRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$OutputRedirection.html b/api/io/github/vigoo/prox/RedirectionModule$OutputRedirection.html new file mode 100644 index 00000000..d2f36af8 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$OutputRedirection.html @@ -0,0 +1,12 @@ +

Packages

sealed trait OutputRedirection extends AnyRef

Supported output redirection types. Should not be used directly, see the +redirection traits instead. +

Linear Supertypes
AnyRef, Any
Known Subclasses
OutputFile, OutputStreamThroughPipe, OutputStreamToSink, StdOut
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OutputRedirection
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$OutputRedirectionType$.html b/api/io/github/vigoo/prox/RedirectionModule$OutputRedirectionType$.html new file mode 100644 index 00000000..c7132f9d --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$OutputRedirectionType$.html @@ -0,0 +1,10 @@ +

Packages

object OutputRedirectionType

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

Type Members

  1. type Aux[R, O] = Prox.OutputRedirectionType[R] { type Out = O }

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. implicit def outputRedirectionTypeOfFile: Aux[Prox.OutputFile, Unit]
  15. implicit def outputRedirectionTypeOfStdOut: Aux[Prox.StdOut, Unit]
  16. implicit def outputRedirectionTypeOfStreamThroughPipe[O, OR]: Aux[Prox.OutputStreamThroughPipe[O, OR], OR]
  17. implicit def outputRedirectionTypeOfStreamToSink[O]: Aux[Prox.OutputStreamToSink, Unit]
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$OutputRedirectionType.html b/api/io/github/vigoo/prox/RedirectionModule$OutputRedirectionType.html new file mode 100644 index 00000000..bb61b42d --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$OutputRedirectionType.html @@ -0,0 +1,10 @@ +

Packages

trait OutputRedirectionType[R] extends AnyRef

Helper type class for output and error redirection dependent typing

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

Type Members

  1. abstract type Out

Abstract Value Members

  1. abstract def runner(of: R)(nativeStream: java.io.InputStream): Prox.ProxIO[Out]

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$OutputStreamThroughPipe.html b/api/io/github/vigoo/prox/RedirectionModule$OutputStreamThroughPipe.html new file mode 100644 index 00000000..1924a76f --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$OutputStreamThroughPipe.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox.RedirectionModule

OutputStreamThroughPipe

case class OutputStreamThroughPipe[O, OR](pipe: Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.OutputRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OutputStreamThroughPipe
  2. Serializable
  3. Product
  4. Equals
  5. OutputRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new OutputStreamThroughPipe(pipe: Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val chunkSize: Int
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. val pipe: Prox.ProxPipe[Byte, O]
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. val runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR]
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.OutputRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$OutputStreamToSink.html b/api/io/github/vigoo/prox/RedirectionModule$OutputStreamToSink.html new file mode 100644 index 00000000..e58ef71e --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$OutputStreamToSink.html @@ -0,0 +1,10 @@ +

Packages

case class OutputStreamToSink(sink: Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.OutputRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OutputStreamToSink
  2. Serializable
  3. Product
  4. Equals
  5. OutputRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new OutputStreamToSink(sink: Prox.ProxSink[Byte], chunkSize: Int = 8192)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val chunkSize: Int
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. val sink: Prox.ProxSink[Byte]
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.OutputRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$RedirectableError.html b/api/io/github/vigoo/prox/RedirectionModule$RedirectableError.html new file mode 100644 index 00000000..b97a7a52 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$RedirectableError.html @@ -0,0 +1,92 @@ +

Packages

trait RedirectableError[+P[_] <: Prox.Process[_, _]] extends AnyRef

The capability to redirect the error output of a process +

P

+ Self type without the RedirectableError capability

Linear Supertypes
AnyRef, Any
Known Subclasses
ProcessImpl, ProcessImplI, ProcessImplIO, ProcessImplO
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedirectableError
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def connectError[R <: Prox.OutputRedirection, E](target: R)(implicit outputRedirectionType: Aux[R, E]): P[E]

    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

    E

    + Error output 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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. 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 +

    path

    + Target file path

    returns

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

  3. def !>(sink: Prox.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 +

    sink

    + Target sink

    returns

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

  4. def !>#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[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 +

    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.

  5. 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 +

    path

    + Target file path

    returns

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

  6. def !>?[O](pipe: Prox.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 +

    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.

  7. final def ##: Int
    Definition Classes
    AnyRef → Any
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. 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 !>> +

    path

    + Target file path

    returns

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

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def drainError[O](pipe: Prox.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. +

    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.

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. 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 !> +

    path

    + Target file path

    returns

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

  16. def errorToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[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 !># +

    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.

  17. def errorToSink(sink: Prox.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 !> +

    sink

    + Target sink

    returns

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

  18. def errorToVector[O](pipe: Prox.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 !>? +

    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.

  19. def foldError[O, R](pipe: Prox.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. +

    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.

  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$RedirectableErrors$$CustomizedPerProcess.html b/api/io/github/vigoo/prox/RedirectionModule$RedirectableErrors$$CustomizedPerProcess.html new file mode 100644 index 00000000..08f0c060 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$RedirectableErrors$$CustomizedPerProcess.html @@ -0,0 +1,58 @@ +

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 RedirectionModule extends AnyRef
    Definition Classes
    prox
  • object RedirectableErrors
    Definition Classes
    RedirectionModule
  • CustomizedPerProcess

trait CustomizedPerProcess[+P[_] <: Prox.ProcessGroup[_, _]] extends AnyRef

Advanced version of the RedirectableErrors interface enabling +per-process customizations. +

P

+ Self type without RedirectableErrors

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

Abstract Value Members

  1. abstract def connectErrors[R <: Prox.GroupErrorRedirection, OR <: Prox.OutputRedirection, E](target: R)(implicit groupErrorRedirectionType: Aux[R, OR, E], outputRedirectionType: Aux[OR, E]): P[E]

    See RedirectableErrors.connectErrors

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 appendErrorsToFile(pathFn: (Prox.Process[_, _]) => Path): P[Unit]

    Redirects the error outputs to one file per process in append mode

    Redirects the error outputs to one file per process in append mode

    The process error output type will be Unit. +

    pathFn

    + A function to get a file path for each process in the group

    returns

    + Returns a new process group with all the error streams redirected + and the error redirection capability removed.

  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. def drainErrors[O](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O]): P[Unit]

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

    Redirects the error outputs 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

    pipeFn

    + A function to get a pipe for each process in the group

    returns

    + Returns a new process group with all the error streams redirected + and the error redirection capability removed.

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def errorsToFile(pathFn: (Prox.Process[_, _]) => Path): P[Unit]

    Redirects the error outputs to one file per process

    Redirects the error outputs to one file per process

    The process error output type will be Unit. +

    pathFn

    + A function to get a file path for each process in the group

    returns

    + Returns a new process group with all the error streams redirected + and the error redirection capability removed.

  11. def errorsToFoldMonoid[O](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): P[O]

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

    Redirects the error outputs 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. +

    O

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

    pipeFn

    + A function to get a pipe for each process in the group

    returns

    + Returns a new process group with all the error streams redirected + and the error redirection capability removed.

  12. def errorsToSink(sinkFn: (Prox.Process[_, _]) => Prox.ProxSink[Byte]): P[Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

    The process error output type will be Unit. +

    sinkFn

    + Function to get a sink for each process in the group

    returns

    + Returns a new process group with all the error streams redirected + and the error redirection capability removed.

  13. def errorsToVector[O](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O]): P[Vector[O]]

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

    Redirects the error outputs 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. +

    O

    + Output type of the pipe

    pipeFn

    + A function to get a pipe for each process in the group

    returns

    + Returns a new process group with all the error streams redirected + and the error redirection capability removed.

  14. def foldErrors[O, R](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): P[R]

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

    Redirects the error outputs 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

    pipeFn

    + A function to get a pipe for each process in the group

    init

    + The initial value for the fold

    fn

    + The fold function

    returns

    + Returns a new process group with all the error streams redirected + and the error redirection capability removed.

  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  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()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$RedirectableErrors$.html b/api/io/github/vigoo/prox/RedirectionModule$RedirectableErrors$.html new file mode 100644 index 00000000..313aa8f0 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$RedirectableErrors$.html @@ -0,0 +1,14 @@ +

Packages

object RedirectableErrors

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

Type Members

  1. trait CustomizedPerProcess[+P[_] <: Prox.ProcessGroup[_, _]] extends AnyRef

    Advanced version of the RedirectableErrors interface enabling +per-process customizations.

    Advanced version of the RedirectableErrors interface enabling +per-process customizations. +

    P

    + Self type without RedirectableErrors

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$RedirectableErrors.html b/api/io/github/vigoo/prox/RedirectionModule$RedirectableErrors.html new file mode 100644 index 00000000..3e444f8e --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$RedirectableErrors.html @@ -0,0 +1,85 @@ +

Packages

trait RedirectableErrors[+P[_] <: Prox.ProcessGroup[_, _]] extends AnyRef

The capability to redirect all the error outputs simultaneously of a +process group +

P

+ Self type without the RedirectableErrors capability

Linear Supertypes
AnyRef, Any
Known Subclasses
ProcessGroupImpl, ProcessGroupImplI, ProcessGroupImplIO, ProcessGroupImplO
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedirectableErrors
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def connectErrors[R <: Prox.GroupErrorRedirection, OR <: Prox.OutputRedirection, E](target: R)(implicit groupErrorRedirectionType: Aux[R, OR, E], outputRedirectionType: Aux[OR, E]): P[E]

    The low level operation to attach an error output to all the processes +in the group.

    The low level operation to attach an error output to all the processes +in the group.

    Use one of the other methods of this trait or the advanced interface +represented by customizedPerProcess for convenience.

    This is the place where the process group's error output type gets +calculated using the GroupErrorRedirectionType and +OutputRedirectionType type classes. +

    R

    + Error output grouped redirection type

    OR

    + Error output redirection type

    E

    + Error output type

    target

    + Redirection target

    groupErrorRedirectionType

    + Helper for dependent error output type

    outputRedirectionType

    + Helper for dependent error output type

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def !>(sink: Prox.ProxSink[Byte]): P[Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

  3. def !>#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): P[O]

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

    Redirects the error outputs 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 errorsToFoldMonoid +

    O

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

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

  4. def !>?[O](pipe: Prox.ProxPipe[Byte, O]): P[Vector[O]]

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

    Redirects the error outputs 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 errorsToVector +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. lazy val customizedPerProcess: CustomizedPerProcess[P]

    A more advanced interface for customizing the redirection per process

  10. def drainErrors[O](pipe: Prox.ProxPipe[Byte, O]): P[Unit]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def errorsToFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[O]): P[O]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

  14. def errorsToSink(sink: Prox.ProxSink[Byte]): P[Unit]

    Redirects the error outputs to a sink.

    Redirects the error outputs to a sink.

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

    sink

    + Target sink

    returns

    + Returns a new process group with all the error streams redirected and + the error redirection capability removed.

  15. def errorsToVector[O](pipe: Prox.ProxPipe[Byte, O]): P[Vector[O]]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

  16. def foldErrors[O, R](pipe: Prox.ProxPipe[Byte, O], init: R, fn: (R, O) => R): P[R]

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

    Redirects the error outputs 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 group with all the error streams redirected and + the error redirection capability removed.

  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$RedirectableInput.html b/api/io/github/vigoo/prox/RedirectionModule$RedirectableInput.html new file mode 100644 index 00000000..48901646 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$RedirectableInput.html @@ -0,0 +1,38 @@ +

Packages

trait RedirectableInput[+P <: ProcessLike] extends AnyRef

The capability to redirect the input of a process or process group +

Linear Supertypes
AnyRef, Any
Known Subclasses
ProcessGroupImpl, ProcessGroupImplE, ProcessGroupImplO, ProcessGroupImplOE, ProcessImpl, ProcessImplE, ProcessImplO, ProcessImplOE
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedirectableInput
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def connectInput(source: Prox.InputRedirection): P

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience. +

    source

    + Redirection source

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

Concrete Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): P

    Feed the process input from a byte stream with flushing per chunks +enabled.

    Feed the process input from a byte stream with flushing per chunks +enabled.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. def <(stream: Prox.ProxStream[Byte]): P

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream. +

    stream

    + Input stream

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

  5. def <(path: Path): P

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def fromFile(path: Path): P

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <. +

    path

    + Path to the file

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

  12. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): P

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<. +

    stream

    + Input stream

    flushChunks

    + Flush the process input stream after each chunk

    returns

    + A new process or process group with the input redirected and the input + redirection capability removed.

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$RedirectableOutput.html b/api/io/github/vigoo/prox/RedirectionModule$RedirectableOutput.html new file mode 100644 index 00000000..aa9d13bf --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$RedirectableOutput.html @@ -0,0 +1,89 @@ +

Packages

trait RedirectableOutput[+P[_] <: ProcessLike] extends AnyRef

The capability to redirect the output of a process or a process group +

P

+ Self type without the RedirectableOutput capability

Linear Supertypes
AnyRef, Any
Known Subclasses
ProcessGroupImpl, ProcessGroupImplE, ProcessGroupImplI, ProcessGroupImplIE, ProcessImpl, ProcessImplE, ProcessImplI, ProcessImplIE
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedirectableOutput
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def connectOutput[R <: Prox.OutputRedirection, O](target: R)(implicit outputRedirectionType: Aux[R, O]): P[O]

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

    R

    + Output redirection type

    O

    + Output type

    target

    + Redirection target

    outputRedirectionType

    + Helper for dependent output type

    returns

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

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 >(path: Path): P[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for toFile +

    path

    + Target file path

    returns

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

  5. def >(sink: Prox.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 +

    sink

    + Target sink

    returns

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

  6. def >#[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[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 +

    O

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

    pipe

    + Target pipe

    returns

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

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

    path

    + Target file path

    returns

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

  8. def >?[O](pipe: Prox.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 +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

  9. 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 >> +

    path

    + Target file path

    returns

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

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def drainOutput[O](pipe: Prox.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. +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def foldOutput[O, R](pipe: Prox.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. +

    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 or process group with its output redirected and + its output redirection capability removed.

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toFile(path: Path): P[Unit]

    Redirects the output to a file natively

    Redirects the output to a file natively

    An alias for > +

    path

    + Target file path

    returns

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

  24. def toFoldMonoid[O](pipe: Prox.ProxPipe[Byte, O])(implicit arg0: Prox.ProxMonoid[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 ># +

    O

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

    pipe

    + Target pipe

    returns

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

  25. def toSink(sink: Prox.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 > +

    sink

    + Target sink

    returns

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

  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def toVector[O](pipe: Prox.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 >? +

    O

    + Output type of the pipe

    pipe

    + Target pipe

    returns

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

  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$StdIn.html b/api/io/github/vigoo/prox/RedirectionModule$StdIn.html new file mode 100644 index 00000000..d5b1bae6 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$StdIn.html @@ -0,0 +1,10 @@ +

Packages

case class StdIn() extends Prox.InputRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.InputRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StdIn
  2. Serializable
  3. Product
  4. Equals
  5. InputRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StdIn()

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  14. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  15. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  16. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.InputRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule$StdOut.html b/api/io/github/vigoo/prox/RedirectionModule$StdOut.html new file mode 100644 index 00000000..7117c013 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule$StdOut.html @@ -0,0 +1,10 @@ +

Packages

case class StdOut() extends Prox.OutputRedirection with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Prox.OutputRedirection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StdOut
  2. Serializable
  3. Product
  4. Equals
  5. OutputRedirection
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StdOut()

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  14. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  15. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  16. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.OutputRedirection

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/RedirectionModule.html b/api/io/github/vigoo/prox/RedirectionModule.html new file mode 100644 index 00000000..749946f0 --- /dev/null +++ b/api/io/github/vigoo/prox/RedirectionModule.html @@ -0,0 +1,28 @@ +

Packages

t

io.github.vigoo.prox

RedirectionModule

trait RedirectionModule extends AnyRef

Self Type
Prox
Linear Supertypes
AnyRef, Any
Known Subclasses
Prox, ProxFS2, ProxZStream, zstream
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedirectionModule
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class AllCapturedThroughPipe[O, OR](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
  2. case class AllCapturedToSink(sinkFn: (Prox.Process[_, _]) => Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
  3. case class AllToFile(pathFn: (Prox.Process[_, _]) => Path, append: Boolean) extends Prox.GroupErrorRedirection with Product with Serializable
  4. case class AllToStdErr() extends Prox.GroupErrorRedirection with Product with Serializable
  5. sealed trait GroupErrorRedirection extends AnyRef

    Supported process group error redirection types.

    Supported process group error redirection types. Should not be used +directly, see the redirection traits instead. +

  6. trait GroupErrorRedirectionType[R] extends AnyRef

    Helper type class for process group error redirection dependent typing

  7. case class InputFile(path: Path) extends Prox.InputRedirection with Product with Serializable
  8. sealed trait InputRedirection extends AnyRef

    Supported input redirection types.

    Supported input redirection types. Should not be used directly, see the +redirection traits instead. +

  9. case class InputStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean) extends Prox.InputRedirection with Product with Serializable
  10. case class OutputFile(path: Path, append: Boolean) extends Prox.OutputRedirection with Product with Serializable
  11. sealed trait OutputRedirection extends AnyRef

    Supported output redirection types.

    Supported output redirection types. Should not be used directly, see the +redirection traits instead. +

  12. trait OutputRedirectionType[R] extends AnyRef

    Helper type class for output and error redirection dependent typing

  13. case class OutputStreamThroughPipe[O, OR](pipe: Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
  14. case class OutputStreamToSink(sink: Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
  15. trait RedirectableError[+P[_] <: Prox.Process[_, _]] extends AnyRef

    The capability to redirect the error output of a process +

    The capability to redirect the error output of a process +

    P

    + Self type without the RedirectableError capability

  16. trait RedirectableErrors[+P[_] <: Prox.ProcessGroup[_, _]] extends AnyRef

    The capability to redirect all the error outputs simultaneously of a +process group +

    The capability to redirect all the error outputs simultaneously of a +process group +

    P

    + Self type without the RedirectableErrors capability

  17. trait RedirectableInput[+P <: ProcessLike] extends AnyRef

    The capability to redirect the input of a process or process group +

  18. trait RedirectableOutput[+P[_] <: ProcessLike] extends AnyRef

    The capability to redirect the output of a process or a process group +

    The capability to redirect the output of a process or a process group +

    P

    + Self type without the RedirectableOutput capability

  19. case class StdIn() extends Prox.InputRedirection with Product with Serializable
  20. case class StdOut() extends Prox.OutputRedirection with Product with Serializable

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. object GroupErrorRedirectionType
  20. object OutputRedirectionType
  21. object RedirectableErrors

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/SyntaxModule$PipeBuilder.html b/api/io/github/vigoo/prox/SyntaxModule$PipeBuilder.html new file mode 100644 index 00000000..8d9ca314 --- /dev/null +++ b/api/io/github/vigoo/prox/SyntaxModule$PipeBuilder.html @@ -0,0 +1,10 @@ +

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 SyntaxModule extends AnyRef
    Definition Classes
    prox
  • PipeBuilder
  • PipeBuilderSyntax
  • ProcessPiping
  • ProcessStringContextIO

trait PipeBuilder[P] extends AnyRef

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

Abstract Value Members

  1. abstract def build(other: UnboundProcess, channel: Prox.ProxPipe[Byte, Byte]): P

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/SyntaxModule$PipeBuilderSyntax.html b/api/io/github/vigoo/prox/SyntaxModule$PipeBuilderSyntax.html new file mode 100644 index 00000000..5467bbec --- /dev/null +++ b/api/io/github/vigoo/prox/SyntaxModule$PipeBuilderSyntax.html @@ -0,0 +1,10 @@ +

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 SyntaxModule extends AnyRef
    Definition Classes
    prox
  • PipeBuilder
  • PipeBuilderSyntax
  • ProcessPiping
  • ProcessStringContextIO
c

io.github.vigoo.prox.SyntaxModule

PipeBuilderSyntax

class PipeBuilderSyntax[P] extends AnyRef

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

Instance Constructors

  1. new PipeBuilderSyntax(builder: Prox.PipeBuilder[P], channel: Prox.ProxPipe[Byte, Byte])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def to(other: UnboundProcess): P
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/SyntaxModule$ProcessPiping.html b/api/io/github/vigoo/prox/SyntaxModule$ProcessPiping.html new file mode 100644 index 00000000..0e92f7be --- /dev/null +++ b/api/io/github/vigoo/prox/SyntaxModule$ProcessPiping.html @@ -0,0 +1,25 @@ +

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 SyntaxModule extends AnyRef
    Definition Classes
    prox
  • PipeBuilder
  • PipeBuilderSyntax
  • ProcessPiping
  • ProcessStringContextIO

implicit class ProcessPiping extends AnyRef

Extension methods for unbound processes enabling the creation of process +groups +

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

Instance Constructors

  1. new ProcessPiping(process: UnboundProcess)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. def pipeInto(other: UnboundProcess, channel: Prox.ProxPipe[Byte, Byte]): ProcessGroupImpl

    Attaches the output of this process to an other process' input

    Attaches the output of this process to an other process' input

    Use the | or the via methods instead for more readability. +

    other

    + The other process

    channel

    + Pipe between the two processes

    returns

    + Returns a ProcessGroup

  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. def via(channel: Prox.ProxPipe[Byte, Byte]): Prox.PipeBuilderSyntax[ProcessGroupImpl]

    Attaches the output of this process to an other process' input with a +custom channel

    Attaches the output of this process to an other process' input with a +custom channel

    There is a syntax helper step to allow the following syntax:

    val processGroup = process1.via(channel).to(process2)
    channel

    + Pipe between the two processes

    returns

    + Returns a syntax helper trait that has a PipeBuilderSyntax.to + method to finish the construction

  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. def |(other: UnboundProcess): ProcessGroupImpl

    Attaches the output of this process to an other process' input +

    Attaches the output of this process to an other process' input +

    other

    + The other process

    returns

    + Returns a ProcessGroup

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/SyntaxModule$ProcessStringContextIO.html b/api/io/github/vigoo/prox/SyntaxModule$ProcessStringContextIO.html new file mode 100644 index 00000000..8d30e96d --- /dev/null +++ b/api/io/github/vigoo/prox/SyntaxModule$ProcessStringContextIO.html @@ -0,0 +1,10 @@ +

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 SyntaxModule extends AnyRef
    Definition Classes
    prox
  • PipeBuilder
  • PipeBuilderSyntax
  • ProcessPiping
  • ProcessStringContextIO
c

io.github.vigoo.prox.SyntaxModule

ProcessStringContextIO

implicit class ProcessStringContextIO extends AnyRef

String interpolator for an alternative of Process.apply

val process = proc"ls -hal $dir"
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessStringContextIO
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProcessStringContextIO(ctx: StringContext)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. def proc(args: Any*): ProcessImpl
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/SyntaxModule.html b/api/io/github/vigoo/prox/SyntaxModule.html new file mode 100644 index 00000000..0cc9aed6 --- /dev/null +++ b/api/io/github/vigoo/prox/SyntaxModule.html @@ -0,0 +1,12 @@ +

Packages

t

io.github.vigoo.prox

SyntaxModule

trait SyntaxModule extends AnyRef

Self Type
Prox
Linear Supertypes
AnyRef, Any
Known Subclasses
Prox, ProxFS2, ProxZStream, zstream
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyntaxModule
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait PipeBuilder[P] extends AnyRef
  2. class PipeBuilderSyntax[P] extends AnyRef
  3. implicit class ProcessPiping extends AnyRef

    Extension methods for unbound processes enabling the creation of process +groups +

  4. implicit class ProcessStringContextIO extends AnyRef

    String interpolator for an alternative of Process.apply

    String interpolator for an alternative of Process.apply

    val process = proc"ls -hal $dir"

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/UnknownProxError.html b/api/io/github/vigoo/prox/UnknownProxError.html new file mode 100644 index 00000000..b3290b88 --- /dev/null +++ b/api/io/github/vigoo/prox/UnknownProxError.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

UnknownProxError

final case class UnknownProxError(reason: Throwable) extends ProxError with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, ProxError, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnknownProxError
  2. Serializable
  3. Product
  4. Equals
  5. ProxError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new UnknownProxError(reason: Throwable)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. val reason: Throwable
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toThrowable: Throwable
    Definition Classes
    UnknownProxError → ProxError
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ProxError

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/UnknownProxErrorException.html b/api/io/github/vigoo/prox/UnknownProxErrorException.html new file mode 100644 index 00000000..1771f2ef --- /dev/null +++ b/api/io/github/vigoo/prox/UnknownProxErrorException.html @@ -0,0 +1,10 @@ +

Packages

c

io.github.vigoo.prox

UnknownProxErrorException

final case class UnknownProxErrorException(reason: Throwable) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnknownProxErrorException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new UnknownProxErrorException(reason: Throwable)

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. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  9. def getCause(): Throwable
    Definition Classes
    Throwable
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  12. def getMessage(): String
    Definition Classes
    Throwable
  13. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  14. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  15. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  20. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  21. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(): Unit
    Definition Classes
    Throwable
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val reason: Throwable
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/index.html b/api/io/github/vigoo/prox/index.html new file mode 100644 index 00000000..87044e38 --- /dev/null +++ b/api/io/github/vigoo/prox/index.html @@ -0,0 +1,20 @@ +

Packages

package prox

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

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

Package Members

  1. package java9
  2. package path

    Small helper package to work with Java NIO paths

Type Members

  1. trait CommonModule extends AnyRef
  2. final case class FailedToDestroy(reason: Throwable) extends ProxError with Product with Serializable
  3. final case class FailedToDestroyException(reason: Throwable) extends Exception with Product with Serializable
  4. final case class FailedToQueryState(reason: Throwable) extends ProxError with Product with Serializable
  5. final case class FailedToQueryStateException(reason: Throwable) extends Exception with Product with Serializable
  6. final case class FailedToReadProcessOutput(reason: Throwable) extends ProxError with Product with Serializable
  7. final case class FailedToReadProcessOutputException(reason: Throwable) extends Exception with Product with Serializable
  8. final case class FailedToStartProcess(reason: Throwable) extends ProxError with Product with Serializable
  9. final case class FailedToStartProcessException(reason: Throwable) extends Exception with Product with Serializable
  10. final case class FailedToWaitForExit(reason: Throwable) extends ProxError with Product with Serializable
  11. final case class FailedToWaitForExitException(reason: Throwable) extends Exception with Product with Serializable
  12. final case class FailedToWriteProcessInput(reason: Throwable) extends ProxError with Product with Serializable
  13. final case class FailedToWriteProcessInputException(reason: Throwable) extends Exception with Product with Serializable
  14. final case class MultipleProxErrors(errors: List[ProxError]) extends ProxError with Product with Serializable
  15. final case class MultipleProxErrorsException(value: List[ProxError]) extends Exception with Product with Serializable
  16. trait ProcessGroupModule extends AnyRef
  17. trait ProcessLike extends AnyRef

    Common base trait for processes and process groups, used in constraints in +the redirection traits +

  18. trait ProcessModule extends AnyRef
  19. trait ProcessRunnerModule extends AnyRef
  20. trait Prox extends ProxRuntime with CommonModule with ProcessModule with ProcessGroupModule with RedirectionModule with ProcessRunnerModule with SyntaxModule
  21. sealed trait ProxError extends AnyRef
  22. trait ProxFS2[F[_]] extends Prox
  23. trait ProxRuntime extends AnyRef
  24. trait ProxZStream extends Prox
  25. trait RedirectionModule extends AnyRef
  26. trait SyntaxModule extends AnyRef
  27. final case class UnknownProxError(reason: Throwable) extends ProxError with Product with Serializable
  28. final case class UnknownProxErrorException(reason: Throwable) extends Exception with Product with Serializable

Value Members

  1. object ProxFS2
  2. object zstream extends ProxZStream

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/java9/Java9Module$JVM9ProcessInfo.html b/api/io/github/vigoo/prox/java9/Java9Module$JVM9ProcessInfo.html new file mode 100644 index 00000000..055bb34f --- /dev/null +++ b/api/io/github/vigoo/prox/java9/Java9Module$JVM9ProcessInfo.html @@ -0,0 +1,10 @@ +

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
  • package java9
    Definition Classes
    prox
  • trait Java9Module extends AnyRef
    Definition Classes
    java9
  • JVM9ProcessInfo
  • JVM9ProcessRunner

case class JVM9ProcessInfo(pid: Long) extends (Java9Module.this)#JVMProcessInfo with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, (Java9Module.this)#JVMProcessInfo, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JVM9ProcessInfo
  2. Serializable
  3. Product
  4. Equals
  5. JVMProcessInfo
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JVM9ProcessInfo(pid: Long)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. val pid: Long
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from (Java9Module.this)#JVMProcessInfo

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/java9/Java9Module$JVM9ProcessRunner.html b/api/io/github/vigoo/prox/java9/Java9Module$JVM9ProcessRunner.html new file mode 100644 index 00000000..5a2bcad2 --- /dev/null +++ b/api/io/github/vigoo/prox/java9/Java9Module$JVM9ProcessRunner.html @@ -0,0 +1,40 @@ +

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
  • package java9
    Definition Classes
    prox
  • trait Java9Module extends AnyRef
    Definition Classes
    java9
  • JVM9ProcessInfo
  • JVM9ProcessRunner

class JVM9ProcessRunner extends (Java9Module.this)#JVMProcessRunnerBase[(Java9Module.this)#JVM9ProcessInfo]

Linear Supertypes
(Java9Module.this)#JVMProcessRunnerBase[(Java9Module.this)#JVM9ProcessInfo], (Java9Module.this)#ProcessRunner[(Java9Module.this)#JVM9ProcessInfo], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JVM9ProcessRunner
  2. JVMProcessRunnerBase
  3. ProcessRunner
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JVM9ProcessRunner()

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def getProcessInfo(process: Process): (Java9Module.this)#ProxIO[(Java9Module.this)#JVM9ProcessInfo]
    Attributes
    protected
    Definition Classes
    JVM9ProcessRunner → JVMProcessRunnerBase
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. def start[O, E](processGroup: (Java9Module.this)#ProcessGroup[O, E]): (Java9Module.this)#ProxResource[(Java9Module.this)#ProxFiber[(Java9Module.this)#ProcessGroupResult[O, E]]]

    Starts the process group asynchronously and returns a managed fiber +representing it

    Starts the process group asynchronously and returns a managed fiber +representing it

    Joining the fiber means waiting until the process gets terminated. +Cancelling the fiber terminates the process. +

    O

    + Output type

    E

    + Error output type

    processGroup

    + The process group to be started

    returns

    + interface for handling the running process

    Definition Classes
    ProcessRunner
  16. def start[O, E](process: (Java9Module.this)#Process[O, E]): (Java9Module.this)#ProxResource[(Java9Module.this)#ProxFiber[(Java9Module.this)#ProcessResult[O, E]]]

    Starts the process asynchronously and returns a managed fiber +representing it

    Starts the process asynchronously and returns a managed fiber +representing it

    Joining the fiber means waiting until the process gets terminated. +Cancelling the fiber terminates the process. +

    O

    + Output type

    E

    + Error output type

    process

    + The process to be started

    returns

    + interface for handling the running process

    Definition Classes
    ProcessRunner
  17. def startProcess[O, E](process: (Java9Module.this)#Process[O, E]): (Java9Module.this)#ProxIO[(Java9Module.this)#RunningProcess[O, E, (Java9Module.this)#JVM9ProcessInfo]]

    Starts the process asynchronously and returns the RunningProcess +interface for it +

    Starts the process asynchronously and returns the RunningProcess +interface for it +

    O

    + Output type

    E

    + Error output type

    process

    + The process to be started

    returns

    + interface for handling the running process

    Definition Classes
    JVMProcessRunnerBase → ProcessRunner
  18. def startProcessGroup[O, E](processGroup: (Java9Module.this)#ProcessGroup[O, E]): (Java9Module.this)#ProxIO[(Java9Module.this)#RunningProcessGroup[O, E, (Java9Module.this)#JVM9ProcessInfo]]

    Starts a process group asynchronously and returns an interface for them +

    Starts a process group asynchronously and returns an interface for them +

    O

    + Output type

    E

    + Error output type

    processGroup

    + The process group to start

    returns

    + interface for handling the running process group

    Definition Classes
    JVMProcessRunnerBase → ProcessRunner
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from (Java9Module.this)#JVMProcessRunnerBase[(Java9Module.this)#JVM9ProcessInfo]

Inherited from (Java9Module.this)#ProcessRunner[(Java9Module.this)#JVM9ProcessInfo]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/java9/Java9Module.html b/api/io/github/vigoo/prox/java9/Java9Module.html new file mode 100644 index 00000000..45d40b08 --- /dev/null +++ b/api/io/github/vigoo/prox/java9/Java9Module.html @@ -0,0 +1,10 @@ +

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
  • package java9
    Definition Classes
    prox
  • Java9Module

trait Java9Module extends AnyRef

Self Type
Java9Module with Prox
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Java9Module
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class JVM9ProcessInfo(pid: Long) extends (Java9Module.this)#JVMProcessInfo with Product with Serializable
  2. class JVM9ProcessRunner extends (Java9Module.this)#JVMProcessRunnerBase[(Java9Module.this)#JVM9ProcessInfo]

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/java9/index.html b/api/io/github/vigoo/prox/java9/index.html new file mode 100644 index 00000000..716d33d1 --- /dev/null +++ b/api/io/github/vigoo/prox/java9/index.html @@ -0,0 +1,10 @@ +

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
  • package java9
    Definition Classes
    prox
  • Java9Module
  • package path

    Small helper package to work with Java NIO paths

    Small helper package to work with Java NIO paths

    Definition Classes
    prox

package java9

Type Members

  1. trait Java9Module extends AnyRef

Ungrouped

diff --git a/api/io/github/vigoo/prox/package$$ProcessLike.html b/api/io/github/vigoo/prox/package$$ProcessLike.html new file mode 100644 index 00000000..7a65c072 --- /dev/null +++ b/api/io/github/vigoo/prox/package$$ProcessLike.html @@ -0,0 +1,12 @@ +

Packages

t

io.github.vigoo.prox

ProcessLike

trait ProcessLike extends AnyRef

Common base trait for processes and process groups, used in constraints in +the redirection traits +

Linear Supertypes
AnyRef, Any
Known Subclasses
ProcessGroup, ProcessGroupImpl, ProcessGroupImplE, ProcessGroupImplI, ProcessGroupImplIE, ProcessGroupImplIO, ProcessGroupImplIOE, ProcessGroupImplO, ProcessGroupImplOE, Process, ProcessImpl, ProcessImplE, ProcessImplI, ProcessImplIE, ProcessImplIO, ProcessImplIOE, ProcessImplO, ProcessImplOE
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessLike
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/package$$Prox.html b/api/io/github/vigoo/prox/package$$Prox.html new file mode 100644 index 00000000..8572b415 --- /dev/null +++ b/api/io/github/vigoo/prox/package$$Prox.html @@ -0,0 +1,76 @@ +

Packages

trait Prox extends ProxRuntime with CommonModule with ProcessModule with ProcessGroupModule with RedirectionModule with ProcessRunnerModule with SyntaxModule

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Prox
  2. SyntaxModule
  3. ProcessRunnerModule
  4. RedirectionModule
  5. ProcessGroupModule
  6. ProcessModule
  7. CommonModule
  8. ProxRuntime
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait ProcessLikeConfiguration extends AnyRef
    Definition Classes
    CommonModule
  2. trait ProcessGroup[O, E] extends ProcessLike with Prox.ProcessGroupConfiguration[O, E]

    Process group is two or more processes attached to each other

    Process group is two or more processes attached to each other

    This implements a pipeline of processes. The input of the first process +and the output of the last process is redirectable with the +RedirectableInput and RedirectableOutput traits. The processes are +attached to each other's input/output streams, the pipe between them is +customizable.

    The error streams are also redirectable with the RedirectableErrors +trait. +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessGroupModule
  3. trait ProcessGroupConfiguration[O, E] extends Prox.ProcessLikeConfiguration
    Definition Classes
    ProcessGroupModule
  4. trait ProcessGroupResult[+O, +E] extends AnyRef

    Result of an executed process group +

    Result of an executed process group +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessGroupModule
  5. trait RunningProcessGroup[O, E, +Info] extends AnyRef

    Representation of a running process group +

    Representation of a running process group +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific per-process information type

    Definition Classes
    ProcessGroupModule
  6. case class SimpleProcessGroupResult[+O, +E](exitCodes: Map[Prox.Process[Unit, Unit], Prox.ProxExitCode], output: O, errors: Map[Prox.Process[Unit, Unit], E]) extends Prox.ProcessGroupResult[O, E] with Product with Serializable

    Default implementation of ProcessGroupResult

    Default implementation of ProcessGroupResult

    Definition Classes
    ProcessGroupModule
  7. trait Process[O, E] extends ProcessLike with Prox.ProcessConfiguration

    Describes a system process to be executed

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

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessModule
  8. trait ProcessConfiguration extends Prox.ProcessLikeConfiguration

    The capability to configure process execution details +

    The capability to configure process execution details +

    Definition Classes
    ProcessModule
  9. trait ProcessResult[+O, +E] extends AnyRef

    Result of a finished process +

    Result of a finished process +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessModule
  10. trait RunningProcess[O, E, +Info] extends AnyRef

    Representation of a running process +

    Representation of a running process +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific process information

    Definition Classes
    ProcessModule
  11. case class SimpleProcessResult[+O, +E](exitCode: Prox.ProxExitCode, output: O, error: E) extends Prox.ProcessResult[O, E] with Product with Serializable

    Default implementation of ProcessResult

    Default implementation of ProcessResult

    Definition Classes
    ProcessModule
  12. class JVMProcessInfo extends AnyRef
    Definition Classes
    ProcessRunnerModule
  13. class JVMProcessRunner extends Prox.JVMProcessRunnerBase[Prox.JVMProcessInfo]
    Definition Classes
    ProcessRunnerModule
  14. abstract class JVMProcessRunnerBase[Info <: Prox.JVMProcessInfo] extends Prox.ProcessRunner[Info]

    Default implementation of ProcessRunner using the Java process API

    Default implementation of ProcessRunner using the Java process API

    Definition Classes
    ProcessRunnerModule
  15. class JVMRunningProcess[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcess[O, E, Info]

    Default implementation of RunningProcess using the Java process API

    Default implementation of RunningProcess using the Java process API

    Definition Classes
    ProcessRunnerModule
  16. class JVMRunningProcessGroup[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcessGroup[O, E, Info]

    Default implementation of RunningProcessGroup using the Java process +API +

    Default implementation of RunningProcessGroup using the Java process +API +

    Definition Classes
    ProcessRunnerModule
  17. trait ProcessRunner[Info] extends AnyRef

    Interface for running processes and process groups

    Interface for running processes and process groups

    The default implementation is JVMProcessRunner +

    Info

    + The type of information provided for a started process

    Definition Classes
    ProcessRunnerModule
  18. abstract type ProxExitCode
    Definition Classes
    ProxRuntime
  19. abstract type ProxFiber[_]
    Definition Classes
    ProxRuntime
  20. abstract type ProxIO[_]
    Definition Classes
    ProxRuntime
  21. abstract type ProxMonoid[_]
    Definition Classes
    ProxRuntime
  22. abstract type ProxPipe[_, _]
    Definition Classes
    ProxRuntime
  23. abstract type ProxResource[_]
    Definition Classes
    ProxRuntime
  24. abstract type ProxSink[_]
    Definition Classes
    ProxRuntime
  25. abstract type ProxStream[_]
    Definition Classes
    ProxRuntime
  26. implicit class FiberOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  27. implicit class IOOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  28. implicit class ListProxErrorOps extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  29. implicit class MonoidStreamOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  30. implicit class ResourceOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  31. implicit class StreamOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  32. case class AllCapturedThroughPipe[O, OR](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  33. case class AllCapturedToSink(sinkFn: (Prox.Process[_, _]) => Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  34. case class AllToFile(pathFn: (Prox.Process[_, _]) => Path, append: Boolean) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  35. case class AllToStdErr() extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  36. sealed trait GroupErrorRedirection extends AnyRef

    Supported process group error redirection types.

    Supported process group error redirection types. Should not be used +directly, see the redirection traits instead. +

    Definition Classes
    RedirectionModule
  37. trait GroupErrorRedirectionType[R] extends AnyRef

    Helper type class for process group error redirection dependent typing

    Helper type class for process group error redirection dependent typing

    Definition Classes
    RedirectionModule
  38. case class InputFile(path: Path) extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  39. sealed trait InputRedirection extends AnyRef

    Supported input redirection types.

    Supported input redirection types. Should not be used directly, see the +redirection traits instead. +

    Definition Classes
    RedirectionModule
  40. case class InputStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean) extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  41. case class OutputFile(path: Path, append: Boolean) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  42. sealed trait OutputRedirection extends AnyRef

    Supported output redirection types.

    Supported output redirection types. Should not be used directly, see the +redirection traits instead. +

    Definition Classes
    RedirectionModule
  43. trait OutputRedirectionType[R] extends AnyRef

    Helper type class for output and error redirection dependent typing

    Helper type class for output and error redirection dependent typing

    Definition Classes
    RedirectionModule
  44. case class OutputStreamThroughPipe[O, OR](pipe: Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  45. case class OutputStreamToSink(sink: Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  46. trait RedirectableError[+P[_] <: Prox.Process[_, _]] extends AnyRef

    The capability to redirect the error output of a process +

    The capability to redirect the error output of a process +

    P

    + Self type without the RedirectableError capability

    Definition Classes
    RedirectionModule
  47. trait RedirectableErrors[+P[_] <: Prox.ProcessGroup[_, _]] extends AnyRef

    The capability to redirect all the error outputs simultaneously of a +process group +

    The capability to redirect all the error outputs simultaneously of a +process group +

    P

    + Self type without the RedirectableErrors capability

    Definition Classes
    RedirectionModule
  48. trait RedirectableInput[+P <: ProcessLike] extends AnyRef

    The capability to redirect the input of a process or process group +

    The capability to redirect the input of a process or process group +

    Definition Classes
    RedirectionModule
  49. trait RedirectableOutput[+P[_] <: ProcessLike] extends AnyRef

    The capability to redirect the output of a process or a process group +

    The capability to redirect the output of a process or a process group +

    P

    + Self type without the RedirectableOutput capability

    Definition Classes
    RedirectionModule
  50. case class StdIn() extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  51. case class StdOut() extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  52. trait PipeBuilder[P] extends AnyRef
    Definition Classes
    SyntaxModule
  53. class PipeBuilderSyntax[P] extends AnyRef
    Definition Classes
    SyntaxModule
  54. implicit class ProcessPiping extends AnyRef

    Extension methods for unbound processes enabling the creation of process +groups +

    Extension methods for unbound processes enabling the creation of process +groups +

    Definition Classes
    SyntaxModule
  55. implicit class ProcessStringContextIO extends AnyRef

    String interpolator for an alternative of Process.apply

    String interpolator for an alternative of Process.apply

    val process = proc"ls -hal $dir"
    Definition Classes
    SyntaxModule

Abstract Value Members

  1. abstract def blockingEffect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  2. abstract def bracket[A, B](acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  3. abstract def cancelFiber[A](f: ProxFiber[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  4. abstract def drainStream[A](s: ProxStream[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  5. abstract def drainToJavaOutputStream(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  6. abstract def effect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  7. abstract def exitCodeFromInt(value: Int): ProxExitCode
    Attributes
    protected
    Definition Classes
    ProxRuntime
  8. abstract def foldMonoidStream[A](s: ProxStream[A])(implicit arg0: ProxMonoid[A]): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  9. abstract def foldStream[A, B](s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  10. abstract def fromJavaInputStream(input: java.io.InputStream, chunkSize: Int): ProxStream[Byte]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  11. abstract def identityPipe[A]: ProxPipe[A, A]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  12. abstract def ioFlatMap[A, B](io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  13. abstract def ioMap[A, B](io: ProxIO[A], f: (A) => B): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  14. abstract def joinFiber[A](f: ProxFiber[A]): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  15. abstract def makeResource[A](acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  16. abstract def pure[A](value: A): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  17. abstract def raiseError(error: ProxError): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  18. abstract def runStreamTo[A](s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  19. abstract def startFiber[A](f: ProxIO[A]): ProxIO[ProxFiber[A]]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  20. abstract def streamThrough[A, B](s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  21. abstract def streamToVector[A](s: ProxStream[A]): ProxIO[Vector[A]]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  22. abstract def traverse[A, B](list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  23. abstract def unit: ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxRuntime
  24. abstract def useResource[A, B](r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxRuntime

Concrete Value Members

  1. object ProcessGroup
    Definition Classes
    ProcessGroupModule
  2. object Process
    Definition Classes
    ProcessModule
  3. object JVMProcessRunnerBase
    Definition Classes
    ProcessRunnerModule
  4. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. object GroupErrorRedirectionType
    Definition Classes
    RedirectionModule
  23. object OutputRedirectionType
    Definition Classes
    RedirectionModule
  24. object RedirectableErrors
    Definition Classes
    RedirectionModule

Deprecated Value Members

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

    (Since version 9)

Inherited from SyntaxModule

Inherited from ProcessRunnerModule

Inherited from RedirectionModule

Inherited from ProcessGroupModule

Inherited from ProcessModule

Inherited from CommonModule

Inherited from ProxRuntime

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/path/index.html b/api/io/github/vigoo/prox/path/index.html new file mode 100644 index 00000000..14a8865a --- /dev/null +++ b/api/io/github/vigoo/prox/path/index.html @@ -0,0 +1,10 @@ +

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
  • package java9
    Definition Classes
    prox
  • package path

    Small helper package to work with Java NIO paths

    Small helper package to work with Java NIO paths

    Definition Classes
    prox
  • PathOps

package path

Small helper package to work with Java NIO paths

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

Type Members

  1. implicit class PathOps extends AnyRef

    Extension methods for java.nio.file.Path

Value Members

  1. val home: Path

    The home directory

  2. val root: Path

    The root directory

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/path/package$$PathOps.html b/api/io/github/vigoo/prox/path/package$$PathOps.html new file mode 100644 index 00000000..b99c9bf2 --- /dev/null +++ b/api/io/github/vigoo/prox/path/package$$PathOps.html @@ -0,0 +1,14 @@ +

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
  • package path

    Small helper package to work with Java NIO paths

    Small helper package to work with Java NIO paths

    Definition Classes
    prox
  • PathOps

implicit class PathOps extends AnyRef

Extension methods for java.nio.file.Path

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

Instance Constructors

  1. new PathOps(value: Path)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def /(child: String): Path

    Resolves a child of the given path +

    Resolves a child of the given path +

    child

    + The child's name

    returns

    + Returns the path to the given child

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  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]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/github/vigoo/prox/zstream$.html b/api/io/github/vigoo/prox/zstream$.html new file mode 100644 index 00000000..657883e7 --- /dev/null +++ b/api/io/github/vigoo/prox/zstream$.html @@ -0,0 +1,76 @@ +

Packages

object zstream extends ProxZStream

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. zstream
  2. ProxZStream
  3. Prox
  4. SyntaxModule
  5. ProcessRunnerModule
  6. RedirectionModule
  7. ProcessGroupModule
  8. ProcessModule
  9. CommonModule
  10. ProxRuntime
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait ProcessLikeConfiguration extends AnyRef
    Definition Classes
    CommonModule
  2. trait ProcessGroup[O, E] extends ProcessLike with Prox.ProcessGroupConfiguration[O, E]

    Process group is two or more processes attached to each other

    Process group is two or more processes attached to each other

    This implements a pipeline of processes. The input of the first process +and the output of the last process is redirectable with the +RedirectableInput and RedirectableOutput traits. The processes are +attached to each other's input/output streams, the pipe between them is +customizable.

    The error streams are also redirectable with the RedirectableErrors +trait. +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessGroupModule
  3. trait ProcessGroupConfiguration[O, E] extends Prox.ProcessLikeConfiguration
    Definition Classes
    ProcessGroupModule
  4. trait ProcessGroupResult[+O, +E] extends AnyRef

    Result of an executed process group +

    Result of an executed process group +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessGroupModule
  5. trait RunningProcessGroup[O, E, +Info] extends AnyRef

    Representation of a running process group +

    Representation of a running process group +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific per-process information type

    Definition Classes
    ProcessGroupModule
  6. case class SimpleProcessGroupResult[+O, +E](exitCodes: Map[Prox.Process[Unit, Unit], Prox.ProxExitCode], output: O, errors: Map[Prox.Process[Unit, Unit], E]) extends Prox.ProcessGroupResult[O, E] with Product with Serializable

    Default implementation of ProcessGroupResult

    Default implementation of ProcessGroupResult

    Definition Classes
    ProcessGroupModule
  7. trait Process[O, E] extends ProcessLike with Prox.ProcessConfiguration

    Describes a system process to be executed

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

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessModule
  8. trait ProcessConfiguration extends Prox.ProcessLikeConfiguration

    The capability to configure process execution details +

    The capability to configure process execution details +

    Definition Classes
    ProcessModule
  9. trait ProcessResult[+O, +E] extends AnyRef

    Result of a finished process +

    Result of a finished process +

    O

    + Output type

    E

    + Error output type

    Definition Classes
    ProcessModule
  10. trait RunningProcess[O, E, +Info] extends AnyRef

    Representation of a running process +

    Representation of a running process +

    O

    + Output type

    E

    + Error output type

    Info

    + Runner-specific process information

    Definition Classes
    ProcessModule
  11. case class SimpleProcessResult[+O, +E](exitCode: Prox.ProxExitCode, output: O, error: E) extends Prox.ProcessResult[O, E] with Product with Serializable

    Default implementation of ProcessResult

    Default implementation of ProcessResult

    Definition Classes
    ProcessModule
  12. class JVMProcessInfo extends AnyRef
    Definition Classes
    ProcessRunnerModule
  13. class JVMProcessRunner extends Prox.JVMProcessRunnerBase[Prox.JVMProcessInfo]
    Definition Classes
    ProcessRunnerModule
  14. abstract class JVMProcessRunnerBase[Info <: Prox.JVMProcessInfo] extends Prox.ProcessRunner[Info]

    Default implementation of ProcessRunner using the Java process API

    Default implementation of ProcessRunner using the Java process API

    Definition Classes
    ProcessRunnerModule
  15. class JVMRunningProcess[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcess[O, E, Info]

    Default implementation of RunningProcess using the Java process API

    Default implementation of RunningProcess using the Java process API

    Definition Classes
    ProcessRunnerModule
  16. class JVMRunningProcessGroup[O, E, +Info <: Prox.JVMProcessInfo] extends Prox.RunningProcessGroup[O, E, Info]

    Default implementation of RunningProcessGroup using the Java process +API +

    Default implementation of RunningProcessGroup using the Java process +API +

    Definition Classes
    ProcessRunnerModule
  17. trait ProcessRunner[Info] extends AnyRef

    Interface for running processes and process groups

    Interface for running processes and process groups

    The default implementation is JVMProcessRunner +

    Info

    + The type of information provided for a started process

    Definition Classes
    ProcessRunnerModule
  18. implicit class FiberOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  19. implicit class IOOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  20. implicit class ListProxErrorOps extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  21. implicit class MonoidStreamOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  22. implicit class ResourceOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  23. implicit class StreamOps[A] extends AnyRef
    Attributes
    protected
    Definition Classes
    ProxRuntime
  24. case class TransformAndSink[A, B](transform: (ZStream[Any, ProxError, A]) => ZStream[Any, ProxError, B], sink: ZSink[Any, ProxError, B, Any, Unit]) extends Product with Serializable
    Definition Classes
    ProxZStream
  25. case class AllCapturedThroughPipe[O, OR](pipeFn: (Prox.Process[_, _]) => Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  26. case class AllCapturedToSink(sinkFn: (Prox.Process[_, _]) => Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  27. case class AllToFile(pathFn: (Prox.Process[_, _]) => Path, append: Boolean) extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  28. case class AllToStdErr() extends Prox.GroupErrorRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  29. sealed trait GroupErrorRedirection extends AnyRef

    Supported process group error redirection types.

    Supported process group error redirection types. Should not be used +directly, see the redirection traits instead. +

    Definition Classes
    RedirectionModule
  30. trait GroupErrorRedirectionType[R] extends AnyRef

    Helper type class for process group error redirection dependent typing

    Helper type class for process group error redirection dependent typing

    Definition Classes
    RedirectionModule
  31. case class InputFile(path: Path) extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  32. sealed trait InputRedirection extends AnyRef

    Supported input redirection types.

    Supported input redirection types. Should not be used directly, see the +redirection traits instead. +

    Definition Classes
    RedirectionModule
  33. case class InputStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean) extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  34. case class OutputFile(path: Path, append: Boolean) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  35. sealed trait OutputRedirection extends AnyRef

    Supported output redirection types.

    Supported output redirection types. Should not be used directly, see the +redirection traits instead. +

    Definition Classes
    RedirectionModule
  36. trait OutputRedirectionType[R] extends AnyRef

    Helper type class for output and error redirection dependent typing

    Helper type class for output and error redirection dependent typing

    Definition Classes
    RedirectionModule
  37. case class OutputStreamThroughPipe[O, OR](pipe: Prox.ProxPipe[Byte, O], runner: (Prox.ProxStream[O]) => Prox.ProxIO[OR], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  38. case class OutputStreamToSink(sink: Prox.ProxSink[Byte], chunkSize: Int = 8192) extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  39. trait RedirectableError[+P[_] <: Prox.Process[_, _]] extends AnyRef

    The capability to redirect the error output of a process +

    The capability to redirect the error output of a process +

    P

    + Self type without the RedirectableError capability

    Definition Classes
    RedirectionModule
  40. trait RedirectableErrors[+P[_] <: Prox.ProcessGroup[_, _]] extends AnyRef

    The capability to redirect all the error outputs simultaneously of a +process group +

    The capability to redirect all the error outputs simultaneously of a +process group +

    P

    + Self type without the RedirectableErrors capability

    Definition Classes
    RedirectionModule
  41. trait RedirectableInput[+P <: ProcessLike] extends AnyRef

    The capability to redirect the input of a process or process group +

    The capability to redirect the input of a process or process group +

    Definition Classes
    RedirectionModule
  42. trait RedirectableOutput[+P[_] <: ProcessLike] extends AnyRef

    The capability to redirect the output of a process or a process group +

    The capability to redirect the output of a process or a process group +

    P

    + Self type without the RedirectableOutput capability

    Definition Classes
    RedirectionModule
  43. case class StdIn() extends Prox.InputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  44. case class StdOut() extends Prox.OutputRedirection with Product with Serializable
    Definition Classes
    RedirectionModule
  45. trait PipeBuilder[P] extends AnyRef
    Definition Classes
    SyntaxModule
  46. class PipeBuilderSyntax[P] extends AnyRef
    Definition Classes
    SyntaxModule
  47. implicit class ProcessPiping extends AnyRef

    Extension methods for unbound processes enabling the creation of process +groups +

    Extension methods for unbound processes enabling the creation of process +groups +

    Definition Classes
    SyntaxModule
  48. implicit class ProcessStringContextIO extends AnyRef

    String interpolator for an alternative of Process.apply

    String interpolator for an alternative of Process.apply

    val process = proc"ls -hal $dir"
    Definition Classes
    SyntaxModule
  49. type ProxExitCode = ExitCode
    Definition Classes
    ProxZStream → ProxRuntime
  50. type ProxFiber[A] = Fiber[ProxError, A]
    Definition Classes
    ProxZStream → ProxRuntime
  51. type ProxIO[A] = ZIO[Any, ProxError, A]
    Definition Classes
    ProxZStream → ProxRuntime
  52. type ProxMonoid[A] = Identity[A]
    Definition Classes
    ProxZStream → ProxRuntime
  53. type ProxPipe[A, B] = (ProxStream[A]) => ProxStream[B]
    Definition Classes
    ProxZStream → ProxRuntime
  54. type ProxResource[A] = ZIO[Scope, ProxError, A]
    Definition Classes
    ProxZStream → ProxRuntime
  55. type ProxSink[A] = TransformAndSink[A, _]
    Definition Classes
    ProxZStream → ProxRuntime
  56. type ProxStream[A] = ZStream[Any, ProxError, A]
    Definition Classes
    ProxZStream → ProxRuntime

Value Members

  1. object ProcessGroup
    Definition Classes
    ProcessGroupModule
  2. object Process
    Definition Classes
    ProcessModule
  3. object JVMProcessRunnerBase
    Definition Classes
    ProcessRunnerModule
  4. object TransformAndSink extends Serializable
    Definition Classes
    ProxZStream
  5. object GroupErrorRedirectionType
    Definition Classes
    RedirectionModule
  6. object OutputRedirectionType
    Definition Classes
    RedirectionModule
  7. object RedirectableErrors
    Definition Classes
    RedirectionModule
  8. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def ##: Int
    Definition Classes
    AnyRef → Any
  10. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. final def blockingEffect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  13. final def bracket[A, B](acquire: ProxIO[A])(use: (A) => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  14. final def cancelFiber[A](f: ProxFiber[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @jdk.internal.HotSpotIntrinsicCandidate() @native()
  16. final def drainStream[A](s: ProxStream[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  17. final def drainToJavaOutputStream(stream: ProxStream[Byte], output: OutputStream, flushChunks: Boolean): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  18. final def effect[A](f: => A, wrapError: (Throwable) => ProxError): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. final def exitCodeFromInt(value: Int): ProxExitCode
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  22. final def foldMonoidStream[A](s: ProxStream[A])(implicit arg0: Identity[A]): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  23. final def foldStream[A, B](s: ProxStream[A], init: B, f: (B, A) => B): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  24. final def fromJavaInputStream(input: java.io.InputStream, chunkSize: Int): ProxStream[Byte]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  27. final def identityPipe[A]: ProxPipe[A, A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  28. final def ioFlatMap[A, B](io: ProxIO[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  29. final def ioMap[A, B](io: ProxIO[A], f: (A) => B): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. final def joinFiber[A](f: ProxFiber[A]): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  32. final def makeResource[A](acquire: ProxIO[A], release: (A) => ProxIO[Unit]): ProxResource[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @jdk.internal.HotSpotIntrinsicCandidate() @native()
  36. final def pure[A](value: A): ProxIO[A]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  37. final def raiseError(error: ProxError): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  38. final def runStreamTo[A](s: ProxStream[A], sink: ProxSink[A]): ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  39. implicit def sinkAsTransformAndSink[A](sink: ZSink[Any, ProxError, A, Any, Unit]): TransformAndSink[A, A]
    Definition Classes
    ProxZStream
  40. final def startFiber[A](f: ProxIO[A]): ProxIO[ProxFiber[A]]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  41. final def streamThrough[A, B](s: ProxStream[A], pipe: ProxPipe[A, B]): ProxStream[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  42. final def streamToVector[A](s: ProxStream[A]): ProxIO[Vector[A]]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  43. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. implicit def transducerAsPipe[A, B](transducer: ZPipeline[Any, ProxError, A, B]): ProxPipe[A, B]
    Definition Classes
    ProxZStream
  46. implicit def transducerAsPipeThrowable[A, B](transducer: ZPipeline[Any, Throwable, A, B]): ProxPipe[A, B]
    Definition Classes
    ProxZStream
  47. final def traverse[A, B](list: List[A])(f: (A) => ProxIO[B]): ProxIO[List[B]]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  48. final def unit: ProxIO[Unit]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  49. final def useResource[A, B](r: ProxResource[A], f: (A) => ProxIO[B]): ProxIO[B]
    Attributes
    protected
    Definition Classes
    ProxZStream → ProxRuntime
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from ProxZStream

Inherited from Prox

Inherited from SyntaxModule

Inherited from ProcessRunnerModule

Inherited from RedirectionModule

Inherited from ProcessGroupModule

Inherited from ProcessModule

Inherited from CommonModule

Inherited from ProxRuntime

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/io/index.html b/api/io/index.html new file mode 100644 index 00000000..ce5ea5ea --- /dev/null +++ b/api/io/index.html @@ -0,0 +1,2 @@ +

Packages

p

io

package io

Package Members

  1. package github

Ungrouped

diff --git a/api/lib/MaterialIcons-Regular.eot b/api/lib/MaterialIcons-Regular.eot new file mode 100644 index 00000000..bf67d48b Binary files /dev/null and b/api/lib/MaterialIcons-Regular.eot differ diff --git a/api/lib/MaterialIcons-Regular.ttf b/api/lib/MaterialIcons-Regular.ttf new file mode 100644 index 00000000..683dcd05 Binary files /dev/null and b/api/lib/MaterialIcons-Regular.ttf differ diff --git a/api/lib/MaterialIcons-Regular.woff b/api/lib/MaterialIcons-Regular.woff new file mode 100644 index 00000000..ddd6be3e Binary files /dev/null and b/api/lib/MaterialIcons-Regular.woff differ diff --git a/api/lib/abstract_type.svg b/api/lib/abstract_type.svg new file mode 100644 index 00000000..8a820529 --- /dev/null +++ b/api/lib/abstract_type.svg @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a + + + + + + + diff --git a/api/lib/annotation.svg b/api/lib/annotation.svg new file mode 100644 index 00000000..66063fa3 --- /dev/null +++ b/api/lib/annotation.svg @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @ + + + + + + + diff --git a/api/lib/annotation_comp.svg b/api/lib/annotation_comp.svg new file mode 100644 index 00000000..fe6dcd7b --- /dev/null +++ b/api/lib/annotation_comp.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @ + + + + + + + + diff --git a/api/lib/class.svg b/api/lib/class.svg new file mode 100644 index 00000000..128f74d1 --- /dev/null +++ b/api/lib/class.svg @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + C + + + + + + + diff --git a/api/lib/class_comp.svg b/api/lib/class_comp.svg new file mode 100644 index 00000000..b457207b --- /dev/null +++ b/api/lib/class_comp.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + C + + + + + + + + diff --git a/api/lib/class_diagram.png b/api/lib/class_diagram.png new file mode 100644 index 00000000..9d7aec79 Binary files /dev/null and b/api/lib/class_diagram.png differ diff --git a/api/lib/diagrams.css b/api/lib/diagrams.css new file mode 100644 index 00000000..9dcafdb1 --- /dev/null +++ b/api/lib/diagrams.css @@ -0,0 +1,177 @@ +@font-face { + font-family: 'Material Icons'; + font-style: normal; + font-weight: 400; + src: url(http://github.com/MaterialIcons-Regular.eot); + src: local('Material Icons'), + local('MaterialIcons-Regular'), + url(http://github.com/MaterialIcons-Regular.woff) format('woff'), + url(http://github.com/MaterialIcons-Regular.ttf) format('truetype'); +} + +.material-icons { + font-family: 'Material Icons'; + font-weight: normal; + font-style: normal; + font-size: 24px; + display: inline-block; + width: 1em; + height: 1em; + line-height: 1; + text-transform: none; + letter-spacing: normal; + word-wrap: normal; + white-space: nowrap; + direction: ltr; + -webkit-font-smoothing: antialiased; + text-rendering: optimizeLegibility; + -moz-osx-font-smoothing: grayscale; + font-feature-settings: 'liga'; +} + +.diagram-container { + display: block; +} + +.diagram-container > span.toggle { + z-index: 9; +} + +.diagram { + overflow: hidden; + display: none; + padding-top:15px; +} + +.diagram svg { + display: block; + position: static; + visibility: visible; + z-index: auto; + margin: auto; +} + +.diagram-help { + float:right; + display:none; +} + +.magnifying { + cursor: -webkit-zoom-in ! important; + cursor: -moz-zoom-in ! important; + cursor: pointer; +} + +#close-link { + position: absolute; + z-index: 100; + font-family: Arial, sans-serif; + font-size: 10pt; + text-decoration: underline; + color: #315479; +} + +#close:hover { + text-decoration: none; +} + +#inheritance-diagram { + padding-bottom: 20px; +} + + +#inheritance-diagram-container > span.toggle { + z-index: 2; +} + +.diagram-container.full-screen { + position: fixed !important; + margin: 0; + border-radius: 0; + top: 0em; + bottom: 3em; + left: 0; + width: 100%; + height: 100%; + z-index: 10000; +} + +.diagram-container.full-screen > span.toggle { + display: none; +} + +.diagram-container.full-screen > div.diagram { + position: absolute; + top: 0; right: 0; bottom: 0; left: 0; + margin: auto; +} + +#diagram-controls { + z-index: 2; + position: absolute; + bottom: 1em; + right: 1em; +} + +#diagram-controls > button.diagram-btn { + border-radius: 1.25em; + height: 2.5em; + width: 2.5em; + background-color: #c2c2c2; + color: #fff; + border: 0; + float: left; + margin: 0 0.1em; + cursor: pointer; + line-height: 0.9; + outline: none; +} + +#diagram-controls > button.diagram-btn:hover { + background-color: #e2e2e2; +} + +#diagram-controls > button.diagram-btn > i.material-icons { + font-size: 1.5em; +} + +svg a { + cursor:pointer; +} + +svg text { + font-size: 8.5px; +} + + +svg { + border: 1px solid #999; + overflow: hidden; +} + +svg .node { + white-space: nowrap; +} + +svg .node rect, +svg .node circle, +svg .node ellipse { + stroke: #333; + fill: #fff; + stroke-width: 1.5px; +} + +svg .cluster rect { + stroke: #333; + fill: #000; + fill-opacity: 0.1; + stroke-width: 1.5px; +} + +svg .edgePath path.path { + stroke: #333; + stroke-width: 1.5px; + fill: none; +} + + diff --git a/api/lib/index.css b/api/lib/index.css new file mode 100644 index 00000000..d4e8ec2d --- /dev/null +++ b/api/lib/index.css @@ -0,0 +1,945 @@ +/* Fonts */ +@font-face { + font-family: 'Lato'; + font-style: normal; + font-weight: 100; + src: url('http://github.com/lato-v11-latin-regular.eot'); + src: local('Lato'), local('Lato'), + url('http://github.com/lato-v11-latin-100.eot?#iefix') format('embedded-opentype'), + url('http://github.com/lato-v11-latin-100.woff') format('woff'), + url('http://github.com/lato-v11-latin-100.ttf') format('truetype'); +} + +@font-face { + font-family: 'Lato'; + font-style: normal; + font-weight: 400; + src: url('http://github.com/lato-v11-latin-regular.eot'); + src: local('Lato'), local('Lato'), + url('http://github.com/lato-v11-latin-regular.eot?#iefix') format('embedded-opentype'), + url('http://github.com/lato-v11-latin-regular.woff') format('woff'), + url('http://github.com/lato-v11-latin-regular.ttf') format('truetype'); +} + +@font-face { + font-family: 'Open Sans'; + font-style: normal; + font-weight: 400; + src: url('http://github.com/open-sans-v13-latin-regular.eot'); + src: local('Open Sans'), local('OpenSans'), + url('http://github.com/open-sans-v13-latin-regular.eot?#iefix') format('embedded-opentype'), + url('http://github.com/open-sans-v13-latin-regular.woff') format('woff'), + url('http://github.com/open-sans-v13-latin-regular.ttf') format('truetype'); +} +@font-face { + font-family: 'Open Sans'; + font-style: italic; + font-weight: 400; + src: url('http://github.com/open-sans-v13-latin-400i.eot'); + src: local('Open Sans Italic'), local('OpenSans-Italic'), + url('http://github.com/open-sans-v13-latin-400i.eot?#iefix') format('embedded-opentype'), + url('http://github.com/open-sans-v13-latin-400i.woff') format('woff'), + url('http://github.com/open-sans-v13-latin-400i.ttf') format('truetype'); +} +@font-face { + font-family: 'Open Sans'; + font-style: oblique; + font-weight: 400; + src: url('http://github.com/open-sans-v13-latin-400i.eot'); + src: local('Open Sans Italic'), local('OpenSans-Italic'), + url('http://github.com/open-sans-v13-latin-400i.eot?#iefix') format('embedded-opentype'), + url('http://github.com/open-sans-v13-latin-400i.woff') format('woff'), + url('http://github.com/open-sans-v13-latin-400i.ttf') format('truetype'); +} +@font-face { + font-family: 'Open Sans'; + font-style: normal; + font-weight: 700; + src: url('http://github.com/open-sans-v13-latin-700.eot'); + src: local('Open Sans Bold'), local('OpenSans-Bold'), + url('http://github.com/open-sans-v13-latin-700.eot?#iefix') format('embedded-opentype'), + url('http://github.com/open-sans-v13-latin-700.woff') format('woff'), + url('http://github.com/open-sans-v13-latin-700.ttf') format('truetype'); +} +@font-face { + font-family: 'Open Sans'; + font-style: italic; + font-weight: 700; + src: url('http://github.com/open-sans-v13-latin-700i.eot'); + src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'), + url('http://github.com/open-sans-v13-latin-700i.eot?#iefix') format('embedded-opentype'), + url('http://github.com/open-sans-v13-latin-700i.woff') format('woff'), + url('http://github.com/open-sans-v13-latin-700i.ttf') format('truetype'); +} +@font-face { + font-family: 'Open Sans'; + font-style: oblique; + font-weight: 700; + src: url('http://github.com/open-sans-v13-latin-700i.eot'); + src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'), + url('http://github.com/open-sans-v13-latin-700i.eot?#iefix') format('embedded-opentype'), + url('http://github.com/open-sans-v13-latin-700i.woff') format('woff'), + url('http://github.com/open-sans-v13-latin-700i.ttf') format('truetype'); +} + +@font-face { + font-family: 'Source Code Pro'; + font-style: normal; + font-weight: 400; + src: url('http://github.com/source-code-pro-v6-latin-regular.eot'); + src: local('Source Code Pro'), local('SourceCodePro-Regular'), + url('http://github.com/source-code-pro-v6-latin-regular.eot?#iefix') format('embedded-opentype'), + url('http://github.com/source-code-pro-v6-latin-regular.woff') format('woff'), + url('http://github.com/source-code-pro-v6-latin-regular.ttf') format('truetype'); +} +@font-face { + font-family: 'Source Code Pro'; + font-style: normal; + font-weight: 700; + src: url('http://github.com/source-code-pro-v6-latin-700.eot'); + src: local('Source Code Pro Bold'), local('SourceCodePro-Bold'), + url('http://github.com/source-code-pro-v6-latin-700.eot?#iefix') format('embedded-opentype'), + url('http://github.com/source-code-pro-v6-latin-700.woff') format('woff'), + url('http://github.com/source-code-pro-v6-latin-700.ttf') format('truetype'); +} + +* { + color: inherit; + text-decoration: none; + font-family: "Lato", Arial, sans-serif; + border-width: 0px; + margin: 0px; +} + +u { + text-decoration: underline; +} + +a { + cursor: pointer; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +span.entity > a { + padding: 0.1em 0.5em; + margin-left: 0.2em; +} + +span.entity > a.selected { + background-color: #C2D2DC; + border-radius: 0.2em; +} + +html { + background-color: #f0f3f6; + box-sizing: border-box; +} +*, *:before, *:after { + box-sizing: inherit; +} + +textarea, input { outline: none; } + +#library { + display: none; +} + +#browser { + width: 17.5em; + top: 0px; + left: 0; + bottom: 0px; + display: block; + position: fixed; + background-color: #f0f3f6; +} + +#browser.full-screen { + left: -17.5em; +} + +#search { + background-color: #103a51; /* typesafe blue */ + min-height: 5.5em; + position: fixed; + top: 0; + left: 0; + right: 0; + height: 3em; + min-height: initial; + z-index: 103; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.18), 0 4px 8px rgba(0, 0, 0, 0.28); +} + +#search > h1 { + font-size: 2em; + position: absolute; + left: 0.25em; + top: 0.5em; +} + +#search > h2 { + position: absolute; + left: 3.8em; + top: 3em; +} + +#search > img.scala-logo { + width: 3em; + height: auto; + position: absolute; + left: 5.8em; + top: 0.43em; +} + +#search > span.toggle-sidebar { + position: absolute; + top: 0.8em; + left: 0.2em; + color: #fff; + z-index: 99; + width: 1.5em; + height: 1.5em; +} + +#search > span#doc-title { + color: #fff; + position: absolute; + top: 0.8em; + left: 0; + width: 18em; + text-align: center; + cursor: pointer; + z-index: 2; +} + +#search > span#doc-title > span#doc-version { + color: #c2c2c2; + font-weight: 100; + font-size: 0.72em; + display: inline-block; + width: 12ex; + overflow: hidden; + white-space: nowrap; + text-overflow: ellipsis; +} + +#search > span#doc-title > span#doc-version:hover { + overflow: visible; +} + +#search > span.toggle-sidebar:hover { + cursor: pointer; +} + +/* Pseudo element replacing UTF8-symbol "Trigram From Heaven" */ +#search > span.toggle-sidebar:before { + position: absolute; + top: -0.45em; + left: 0.45em; + content: ""; + display: block; + width: 0.7em; + -webkit-box-shadow: 0 0.8em 0 1px #fff, 0 1.1em 0 1px #fff, 0 1.4em 0 1px #fff; + box-shadow: 0 0.8em 0 1px #fff, 0 1.1em 0 1px #fff, 0 1.4em 0 1px #fff; +} + +#search > span.toggle-sidebar:hover:before { + -webkit-box-shadow: 0 0.8em 0 1px #c2c2c2, 0 1.1em 0 1px #c2c2c2, 0 1.4em 0 1px #c2c2c2; + box-shadow: 0 0.8em 0 1px #c2c2c2, 0 1.1em 0 1px #c2c2c2, 0 1.4em 0 1px #c2c2c2; +} + +#textfilter > .pre { + display: block; + position: absolute; + top: 0; + left: 0; + height: 23px; + width: 21px; +} + +#textfilter { + position: absolute; + top: 0.5em; + bottom: 0.8em; + left: 0; + right: 0; + display: block; + height: 2em; +} + +#textfilter > .input { + position: relative; + display: block; + padding: 0.2em; + max-width: 48.5em; + margin: 0 auto; +} + +#textfilter > .input > i#search-icon { + color: rgba(255,255,255, 0.4); + position: absolute; + left: 0.34em; + top: 0.3em; + font-size: 1.3rem; +} + +#textfilter > span.toggle { + cursor: pointer; + padding-left: 15px; + position: absolute; + left: -0.55em; + top: 3em; + z-index: 99; + color: #fff; + font-size: 0.8em; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +#textfilter > span.toggle:hover { + color: #c2c2c2; +} + +#textfilter > span.toggle:hover { + cursor: pointer; +} + +#textfilter > .hide:hover { + cursor: pointer; + color: #a2a2a2; +} + +#textfilter > .input > input { + font-family: "Open Sans"; + font-size: 0.85em; + height: 2em; + padding: 0 0 0 2.1em; + color: #fff; + width: 100%; + border-radius: 0.2em; + background: rgba(255, 255, 255, 0.2); +} + + +#textfilter > .input > input::-webkit-input-placeholder { + color: rgba(255, 255, 255, 0.4); +} + +#textfilter > .input > input::-moz-placeholder { + color: rgba(255, 255, 255, 0.4); +} + +#textfilter > .input > input:-ms-input-placeholder { + color: rgba(255, 255, 255, 0.4); +} + +#textfilter > .input > input:-moz-placeholder { + color: rgba(255, 255, 255, 0.4); +} + +#focusfilter > .focusremove:hover { + text-decoration: none; +} + +#textfilter > .input > .clear { + display: none; + position: absolute; + font-size: 0.9em; + top: 0.7em; + right: 0.1em; + height: 23px; + width: 21px; + color: rgba(255, 255, 255, 0.4); +} + +#textfilter > .input > .clear:hover { + cursor: pointer; + color: #fff; +} + +#focusfilter { + font-size: 0.9em; + position: relative; + text-align: center; + display: none; + padding: 0.6em; + background-color: #f16665; + color: #fff; + margin: 3.9em 0.55em 0 0.35em; + border-radius: 0.2em; + z-index: 1; +} + +div#search-progress { + position: absolute; + top: 0; + left: 0; + width: 100%; + height: 0.25em; +} + +div#search-progress > div#progress-fill { + width: 0%; + background-color: #f16665; + transition: 0.1s; +} + +#focusfilter .focuscoll { + font-weight: bold; +} + +#focusfilter a.focusremove { + margin-left: 0.2em; + font-size: 0.9em; +} + +#kindfilter-container { + position: fixed; + display: block; + z-index: 99; + bottom: 0.5em; + left: 0; + width: 17.25em; +} + +#kindfilter { + float: right; + text-align: center; + padding: 0.3em 1em; + border-radius: 0.8em; + background: #f16665; + border-bottom: 2px solid #d64546; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + color: #fff; + font-size: 0.8em; +} + +#kindfilter:hover { + cursor: pointer; + background-color: rgb(226, 87, 88); +} + +#letters { + position: relative; + text-align: center; + border: 0; + margin-top: 0em; + color: #fff; +} + +#letters > a, #letters > span { + color: #fff; + font-size: 0.67em; + padding-right: 2px; +} + +#letters > a:hover { + text-decoration: none; + color: #c2c2c2; +} + +#letters > span { + color: #bbb; +} + +div#content-scroll-container { + top: 0; + right: 0; + bottom: 0; + left: 0; + z-index: 100; + overflow-x: hidden; + overflow-y: auto; +} + +div#content-container { + max-width: 1140px; + margin: 0 auto; +} + +div#content-container > div#content { + -webkit-overflow-scrolling: touch; + display: block; + overflow-y: hidden; + max-width: 1140px; + margin: 4em auto 0; +} + +a.anchorToMember { + display: inline-block; + position: relative; + top: -5em; + width: 0; +} + +div#content-container > div#subpackage-spacer { + float: right; + height: 100%; + margin: 1.1rem 0.5rem 0 0.5em; + font-size: 0.8em; + min-width: 8rem; + max-width: 16rem; +} + +div#packages > h1 { + color: #103a51; +} + +div#packages > ul { + list-style-type: none; +} + +div#packages > ul > li { + position: relative; + margin: 0.5rem 0; + width: 100%; + border-radius: 0.2em; + min-height: 1.5em; + padding-left: 2em; +} + +div#packages > ul > li.current-entities { + margin: 0.3rem 0; +} + +div#packages > ul > li.current:hover { + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} + +div#packages > ul > li.current-entities > *:nth-child(1), +div#packages > ul > li.current-entities > *:nth-child(2) { + float: left; + display: inline; + height: 1rem; + width: 1rem; + margin: 1px 0 0 0; + cursor: pointer; +} + +div#packages > ul > li > a.class { + background: url("http://github.com/class.svg") no-repeat center; + background-size: 0.9rem; +} + +div#packages > ul > li > a.trait { + background: url("http://github.com/trait.svg") no-repeat center; + background-size: 0.9rem; +} + +div#packages > ul > li > a.object { + background: url("http://github.com/object.svg") no-repeat center; + background-size: 0.9rem; +} + +div#packages > ul > li > a.abstract.type { + background: url("http://github.com/abstract_type.svg") no-repeat center; + background-size: 0.9rem; +} + +div#packages > ul > li > a.annotation { + background: url("http://github.com/annotation.svg") no-repeat center; + background-size: 0.9rem; +} + +div#packages > ul > li > a { + text-decoration: none !important; + margin-left: 1px; + font-family: "Source Code Pro", "Monaco", "Ubuntu Mono Regular", "Lucida Console", monospace; + font-size: 0.9em; +} + +/* Indentation levels for packages */ +div#packages > ul > li.indented0 { padding-left: 0em; } +div#packages > ul > li.indented1 { padding-left: 1em; } +div#packages > ul > li.indented2 { padding-left: 2em; } +div#packages > ul > li.indented3 { padding-left: 3em; } +div#packages > ul > li.indented4 { padding-left: 4em; } +div#packages > ul > li.indented5 { padding-left: 5em; } +div#packages > ul > li.indented6 { padding-left: 6em; } +div#packages > ul > li.indented7 { padding-left: 7em; } +div#packages > ul > li.indented8 { padding-left: 8em; } +div#packages > ul > li.indented9 { padding-left: 9em; } +div#packages > ul > li.indented10 { padding-left: 10em; } +div#packages > ul > li.current.indented0 { padding-left: -0.5em } +div#packages > ul > li.current.indented1 { padding-left: 0.5em } +div#packages > ul > li.current.indented2 { padding-left: 1.5em } +div#packages > ul > li.current.indented3 { padding-left: 2.5em } +div#packages > ul > li.current.indented4 { padding-left: 3.5em } +div#packages > ul > li.current.indented5 { padding-left: 4.5em } +div#packages > ul > li.current.indented6 { padding-left: 5.5em } +div#packages > ul > li.current.indented7 { padding-left: 6.5em } +div#packages > ul > li.current.indented8 { padding-left: 7.5em } +div#packages > ul > li.current.indented9 { padding-left: 8.5em } +div#packages > ul > li.current.indented10 { padding-left: 9.5em } + +div#packages > ul > li.current > span.symbol { + border-left: 0.25em solid #72D0EB; + padding-left: 0.25em; +} + +div#packages > ul > li > span.symbol > a { + text-decoration: none; +} + +div#packages > ul > li > span.symbol > span.name { + font-weight: normal; +} + +div#packages > ul > li .fullcomment, +div#packages > ul > li .modifier_kind, +div#packages > ul > li .permalink, +div#packages > ul > li .shortcomment { + display: none; +} + +div#search-results { + color: #103a51; + position: absolute; + left: 0; + top: 3em; + right: 0; + bottom: 0; + background-color: rgb(240, 243, 246); + z-index: 101; + overflow-x: hidden; + display: none; + padding: 1em; + -webkit-overflow-scrolling: touch; +} + +div#search > span.close-results { + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + position: fixed; + top: 0.8em; + left: 1em; + color: #fff; + display: none; + z-index: 1; +} + +div#search > span.close-results:hover { + cursor: pointer; +} + +div#results-content { + max-width: 1140px; + margin: 0 auto; +} + +div#results-content > span.search-text { + margin-left: 1em; + font-size: 1.2em; + float: left; + width: 100%; +} + +div#results-content > span.search-text > span.query-str { + font-weight: 900; +} + +div#results-content > div > h1.result-type { + font-size: 1.5em; + margin: 1em 0 0.3em; + font-family: "Open Sans"; + font-weight: 300; + border-bottom: 1px solid #103a51; +} + +div#results-content > div#entity-results { + float: left; + width: 50%; + padding: 1em; + display: inline; +} + +div#results-content > div#member-results { + float: left; + width: 50%; + padding: 1em; + display: inline; +} + +div#results-content > div#member-results > a.package, +div#results-content > div#entity-results > a.package { + font-size: 1em; + margin: 0 0 1em 0; + color: #f16665; + cursor: pointer; +} + +div#results-content > div#member-results > ul.entities, +div#results-content > div#entity-results > ul.entities { + list-style-type: none; + padding-left: 0; +} + +div#results-content > div#member-results > ul.entities > li, +div#results-content > div#entity-results > ul.entities > li { + margin: 0.5em 0; +} + +div#results-content > div#member-results > ul.entities > li > .icon, +div#results-content > div#entity-results > ul.entities > li > .icon { + float: left; + display: inline; + height: 1em; + width: 1em; + margin: 0.23em 0 0; + cursor: pointer; +} + +div#results-content > div#member-results > ul.entities > li > .icon.class, +div#results-content > div#entity-results > ul.entities > li > .icon.class { + background: url("http://github.com/class.svg") no-repeat center; + background-size: 1em 1em; +} + +div#results-content > div#member-results > ul.entities > li > .icon.annotation, +div#results-content > div#entity-results > ul.entities > li > .icon.annotation { + background: url("http://github.com/annotation.svg") no-repeat center; + background-size: 1em 1em; +} + +div#results-content > div#member-results > ul.entities > li > .icon.trait, +div#results-content > div#entity-results > ul.entities > li > .icon.trait { + background: url("http://github.com/trait.svg") no-repeat center; + background-size: 1em 1em; +} + +div#results-content > div#member-results > ul.entities > li > .icon.object, +div#results-content > div#entity-results > ul.entities > li > .icon.object { + background: url("http://github.com/object.svg") no-repeat center; + background-size: 1em 1em; +} + +div#results-content > div#member-results > ul.entities > li > span.entity, +div#results-content > div#entity-results > ul.entities > li > span.entity { + font-size: 1.1em; + font-weight: 900; +} + +div#results-content > div#member-results > ul.entities > li > ul.members, +div#results-content > div#entity-results > ul.entities > li > ul.members { + margin-top: 0.5em; + list-style-type: none; + font-size: 0.85em; + margin-left: 0.2em; +} + +div#results-content > div#member-results > ul.entities > li > ul.members > li, +div#results-content > div#entity-results > ul.entities > li > ul.members > li { + margin: 0.5em 0; +} + +div#results-content > div#member-results > ul.entities > li > ul.members > li > span.kind, +div#results-content > div#member-results > ul.entities > li > ul.members > li > span.tail, +div#results-content > div#entity-results > ul.entities > li > ul.members > li > span.kind, +div#results-content > div#entity-results > ul.entities > li > ul.members > li > span.tail { + margin-right: 0.6em; + font-family: "Source Code Pro", "Monaco", "Ubuntu Mono Regular", "Lucida Console", monospace; +} + +div#results-content > div#member-results > ul.entities > li > ul.members > li > span.kind { + font-weight: 600; +} + +div#results-content > div#member-results > ul.entities > li > ul.members > li > a.label, +div#results-content > div#entity-results > ul.entities > li > ul.members > li > a.label { + color: #2C3D9B; + font-family: "Source Code Pro", "Monaco", "Ubuntu Mono Regular", "Lucida Console", monospace; +} + +/** Scrollpane settings needed for jquery.scrollpane.min.js */ +.jspContainer { + overflow: hidden; + position: relative; +} + +.jspPane { + position: absolute; +} + +.jspVerticalBar { + position: absolute; + top: 0; + right: 0; + width: 0.6em; + height: 100%; + background: transparent; +} + +.jspHorizontalBar { + position: absolute; + bottom: 0; + left: 0; + width: 100%; + height: 16px; + background: red; +} + +.jspCap { + display: none; +} + +.jspHorizontalBar .jspCap { + float: left; +} + +.jspTrack { + background: #f0f3f6; + position: relative; +} + +.jspDrag { + display: none; + background: rgba(0, 0, 0, 0.35); + position: relative; + top: 0; + left: 0; + cursor: pointer; +} + +#tpl:hover .jspDrag { + display: block; +} + +.jspHorizontalBar .jspTrack, +.jspHorizontalBar .jspDrag { + float: left; + height: 100%; +} + +.jspArrow { + background: #50506d; + text-indent: -20000px; + display: block; + cursor: pointer; + padding: 0; + margin: 0; +} + +.jspArrow.jspDisabled { + cursor: default; + background: #80808d; +} + +.jspVerticalBar .jspArrow { + height: 16px; +} + +.jspHorizontalBar .jspArrow { + width: 16px; + float: left; + height: 100%; +} + +.jspVerticalBar .jspArrow:focus { + outline: none; +} + +.jspCorner { + background: #eeeef4; + float: left; + height: 100%; +} + +/* CSS Hack for IE6 3 pixel bug */ +* html .jspCorner { + margin: 0 -3px 0 0; +} + +/* Media query rules for smaller viewport */ +@media only screen /* Large screen with a small window */ +and (max-width: 1300px) +{ + #textfilter { + left: 17.8em; + right: 0.35em; + } + + #textfilter .input { + max-width: none; + margin: 0; + } +} + +@media only screen /* Large screen with a smaller window */ +and (max-width: 800px) +{ + div#results-content > div#entity-results { + width: 100%; + padding: 0em; + } + + div#results-content > div#member-results { + width: 100%; + padding: 0em; + } +} + +/* Media query rules specifically for mobile devices */ +@media +screen /* HiDPI device like Nexus 5 */ +and (max-device-width: 360px) +and (max-device-height: 640px) +and (-webkit-device-pixel-ratio: 3) +, +screen /* Most mobile devices */ +and (max-device-width: 480px) +and (orientation: portrait) +, +only screen /* iPhone 6 */ +and (max-device-width: 667px) +and (-webkit-device-pixel-ratio: 2) +{ + div#content-container > div#subpackage-spacer { + display: none; + } + + div#content-container > div#content { + margin: 3.3em auto 0; + } + + #search > span#doc-title { + width: 100%; + text-align: left; + padding-left: 0.7em; + top: 0.95em; + z-index: 1; + } + + #search > div#textfilter { + z-index: 2; + } + + #search > span#doc-title > span#doc-version { + display: none; + } + + #textfilter { + left: 12.2em; + } +} diff --git a/api/lib/index.js b/api/lib/index.js new file mode 100644 index 00000000..c3953901 --- /dev/null +++ b/api/lib/index.js @@ -0,0 +1,616 @@ +// © 2009–2010 EPFL/LAMP +// code by Gilles Dubochet with contributions by Johannes Rudolph, "spiros", Marcin Kubala and Felix Mulder + +var scheduler = undefined; + +var title = $(document).attr('title'); + +var lastFragment = ""; + +var Index = {}; +(function (ns) { + ns.keyLength = 0; + ns.keys = function (obj) { + var result = []; + var key; + for (key in obj) { + result.push(key); + ns.keyLength++; + } + return result; + } +})(Index); + +/** Find query string from URL */ +var QueryString = function(key) { + if (QueryString.map === undefined) { // only calc once + QueryString.map = {}; + var keyVals = window.location.search.split("?").pop().split("&"); + keyVals.forEach(function(elem) { + var pair = elem.split("="); + if (pair.length == 2) QueryString.map[pair[0]] = pair[1]; + }); + } + + return QueryString.map[key]; +}; + +$(document).ready(function() { + // Clicking #doc-title returns the user to the root package + $("#doc-title").on("click", function() { document.location = toRoot + "index.html" }); + + scheduler = new Scheduler(); + scheduler.addLabel("init", 1); + scheduler.addLabel("focus", 2); + scheduler.addLabel("filter", 4); + scheduler.addLabel("search", 5); + + configureTextFilter(); + + $("#index-input").on("input", function(e) { + if($(this).val().length > 0) + $("#textfilter > .input > .clear").show(); + else + $("#textfilter > .input > .clear").hide(); + }); + + if (QueryString("search") !== undefined) { + $("#index-input").val(QueryString("search")); + searchAll(); + } +}); + +/* Handles all key presses while scrolling around with keyboard shortcuts in search results */ +function handleKeyNavigation() { + /** Iterates both back and forth among selected elements */ + var EntityIterator = function (litems, ritems) { + var it = this; + this.index = -1; + + this.items = litems; + this.litems = litems; + this.ritems = ritems; + + if (litems.length == 0) + this.items = ritems; + + /** Returns the next entry - if trying to select past last element, it + * returns the last element + */ + it.next = function() { + it.index = Math.min(it.items.length - 1, it.index + 1); + return $(it.items[it.index]); + }; + + /** Returns the previous entry - will return `undefined` instead if + * selecting up from first element + */ + it.prev = function() { + it.index = Math.max(-1, it.index - 1); + return it.index == -1 ? undefined : $(it.items[it.index]); + }; + + it.right = function() { + if (it.ritems.length != 0) { + it.items = it.ritems; + it.index = Math.min(it.index, it.items.length - 1); + } + return $(it.items[it.index]); + }; + + it.left = function() { + if (it.litems.length != 0) { + it.items = it.litems; + it.index = Math.min(it.index, it.items.length - 1); + } + return $(it.items[it.index]); + }; + }; + + function safeOffset($elem) { + return $elem.length ? $elem.offset() : { top:0, left:0 }; // offset relative to viewport + } + + /** Scroll helper, ensures that the selected elem is inside the viewport */ + var Scroller = function ($container) { + scroller = this; + scroller.container = $container; + + scroller.scrollDown = function($elem) { + var offset = safeOffset($elem); + if (offset !== undefined) { + var yPos = offset.top; + if ($container.height() < yPos || (yPos - $("#search").height()) < 0) { + $container.animate({ + scrollTop: $container.scrollTop() + yPos - $("#search").height() - 10 + }, 200); + } + } + }; + + scroller.scrollUp = function ($elem) { + var offset = safeOffset($elem); + if (offset !== undefined) { + var yPos = offset.top; + if (yPos < $("#search").height()) { + $container.animate({ + scrollTop: $container.scrollTop() + yPos - $("#search").height() - 10 + }, 200); + } + } + }; + + scroller.scrollTop = function() { + $container.animate({ + scrollTop: 0 + }, 200); + } + }; + + scheduler.add("init", function() { + $("#textfilter input").trigger("blur"); + var items = new EntityIterator( + $("div#results-content > div#entity-results > ul.entities span.entity > a").toArray(), + $("div#results-content > div#member-results > ul.entities span.entity > a").toArray() + ); + + var scroller = new Scroller($("#search-results")); + + var $old = items.next(); + $old.addClass("selected"); + scroller.scrollDown($old); + + $(window).on("keydown", function(e) { + switch ( e.keyCode ) { + case 9: // tab + $old.removeClass("selected"); + break; + + case 13: // enter + var href = $old.attr("href"); + location.replace(href); + $old.trigger("click"); + $("#textfilter input").val(""); + break; + + case 27: // escape + $("#textfilter input").val(""); + $("div#search-results").hide(); + $("#search > span.close-results").hide(); + $("#search > span#doc-title").show(); + break; + + case 37: // left + var oldTop = safeOffset($old).top; + $old.removeClass("selected"); + $old = items.left(); + $old.addClass("selected"); + + (oldTop - safeOffset($old).top < 0 ? scroller.scrollDown : scroller.scrollUp)($old); + break; + + case 38: // up + $old.removeClass('selected'); + $old = items.prev(); + + if ($old === undefined) { // scroll past top + $(window).off("keydown"); + $("#textfilter input").trigger("focus"); + scroller.scrollTop(); + return false; + } else { + $old.addClass("selected"); + scroller.scrollUp($old); + } + break; + + case 39: // right + var oldTop = safeOffset($old).top; + $old.removeClass("selected"); + $old = items.right(); + $old.addClass("selected"); + + (oldTop - safeOffset($old).top < 0 ? scroller.scrollDown : scroller.scrollUp)($old); + break; + + case 40: // down + $old.removeClass("selected"); + $old = items.next(); + $old.addClass("selected"); + scroller.scrollDown($old); + break; + } + }); + }); +} + +/* Configures the text filter */ +function configureTextFilter() { + scheduler.add("init", function() { + var input = $("#textfilter input"); + input.on('keyup', function(event) { + switch ( event.keyCode ) { + case 27: // escape + input.val(""); + $("div#search-results").hide(); + $("#search > span.close-results").hide(); + $("#search > span#doc-title").show(); + break; + + case 38: // up arrow + return false; + + case 40: // down arrow + $(window).off("keydown"); + handleKeyNavigation(); + return false; + } + + searchAll(); + }); + }); + scheduler.add("init", function() { + $("#textfilter > .input > .clear").on("click", function() { + $("#textfilter input").val(""); + $("div#search-results").hide(); + $("#search > span.close-results").hide(); + $("#search > span#doc-title").show(); + + $(this).hide(); + }); + }); + + scheduler.add("init", function() { + $("div#search > span.close-results").on("click", function() { + $("div#search-results").hide(); + $("#search > span.close-results").hide(); + $("#search > span#doc-title").show(); + $("#textfilter input").val(""); + }); + }); +} + +function compilePattern(query) { + var escaped = query.replace(/([\.\*\+\?\|\(\)\[\]\\])/g, '\\$1'); + + if (query.toLowerCase() != query) { + // Regexp that matches CamelCase subbits: "BiSe" is + // "[a-z]*Bi[a-z]*Se" and matches "BitSet", "ABitSet", ... + return new RegExp(escaped.replace(/([A-Z])/g,"[a-z]*$1")); + } + else { // if query is all lower case make a normal case insensitive search + return new RegExp(escaped, "i"); + } +} + +/** Searches packages for entities matching the search query using a regex + * + * @param {[Object]} pack: package being searched + * @param {RegExp} regExp: a regular expression for finding matching entities + */ +function searchPackage(pack, regExp) { + scheduler.add("search", function() { + var entities = Index.PACKAGES[pack]; + var matched = []; + var notMatching = []; + + scheduler.add("search", function() { + searchMembers(entities, regExp, pack); + }); + + entities.forEach(function (elem) { + regExp.test(elem.name) ? matched.push(elem) : notMatching.push(elem); + }); + + var results = { + "matched": matched, + "package": pack + }; + + scheduler.add("search", function() { + handleSearchedPackage(results, regExp); + setProgress(); + }); + }); +} + +function searchMembers(entities, regExp, pack) { + var memDiv = document.getElementById("member-results"); + var packLink = document.createElement("a"); + packLink.className = "package"; + packLink.appendChild(document.createTextNode(pack)); + packLink.style.display = "none"; + packLink.title = pack; + packLink.href = toRoot + urlFriendlyEntity(pack).replace(new RegExp("\\.", "g"), "/") + "/index.html"; + memDiv.appendChild(packLink); + + var entityUl = document.createElement("ul"); + entityUl.className = "entities"; + memDiv.appendChild(entityUl); + + entities.forEach(function(entity) { + var entityLi = document.createElement("li"); + var name = entity.name.split('.').pop() + + var iconElem = document.createElement("a"); + iconElem.className = "icon " + entity.kind; + iconElem.title = name + " " + entity.kind; + iconElem.href = toRoot + entity[entity.kind]; + entityLi.appendChild(iconElem); + + if (entity.kind != "object" && entity.object) { + var companion = document.createElement("a"); + companion.className = "icon object"; + companion.title = name + " companion object"; + companion.href = toRoot + entity.object; + entityLi.insertBefore(companion, iconElem); + } else { + var spacer = document.createElement("div"); + spacer.className = "icon spacer"; + entityLi.insertBefore(spacer, iconElem); + } + + var nameElem = document.createElement("span"); + nameElem.className = "entity"; + + var entityUrl = document.createElement("a"); + entityUrl.title = entity.shortDescription ? entity.shortDescription : name; + entityUrl.href = toRoot + entity[entity.kind]; + entityUrl.appendChild(document.createTextNode(name)); + + nameElem.appendChild(entityUrl); + entityLi.appendChild(nameElem); + + var membersUl = document.createElement("ul"); + membersUl.className = "members"; + entityLi.appendChild(membersUl); + + + searchEntity(entity, membersUl, regExp) + .then(function(res) { + if (res.length > 0) { + packLink.style.display = "block"; + entityUl.appendChild(entityLi); + } + }); + }); +} + +/** This function inserts `li` into the `ul` ordered by the li's id + * + * @param {Node} ul: the list in which to insert `li` + * @param {Node} li: item to insert + */ +function insertSorted(ul, li) { + var lis = ul.childNodes; + var beforeLi = null; + + for (var i = 0; i < lis.length; i++) { + if (lis[i].id > li.id) + beforeLi = lis[i]; + } + + // if beforeLi == null, it will be inserted last + ul.insertBefore(li, beforeLi); +} + +/** Defines the callback when a package has been searched and searches its + * members + * + * It will search all entities which matched the regExp. + * + * @param {Object} res: this is the searched package. It will contain the map + * from the `searchPackage`function. + * @param {RegExp} regExp + */ +function handleSearchedPackage(res, regExp) { + $("div#search-results").show(); + $("#search > span.close-results").show(); + $("#search > span#doc-title").hide(); + + var searchRes = document.getElementById("results-content"); + var entityDiv = document.getElementById("entity-results"); + + var packLink = document.createElement("a"); + packLink.className = "package"; + packLink.title = res.package; + packLink.href = toRoot + urlFriendlyEntity(res.package).replace(new RegExp("\\.", "g"), "/") + "/index.html"; + packLink.appendChild(document.createTextNode(res.package)); + + if (res.matched.length == 0) + packLink.style.display = "none"; + + entityDiv.appendChild(packLink); + + var ul = document.createElement("ul") + ul.className = "entities"; + + // Generate html list items from results + res.matched + .map(function(entity) { return listItem(entity, regExp); }) + .forEach(function(li) { ul.appendChild(li); }); + + entityDiv.appendChild(ul); +} + +/** Searches an entity asynchronously for regExp matches in an entity's members + * + * @param {Object} entity: the entity to be searched + * @param {Node} ul: the list in which to insert the list item created + * @param {RegExp} regExp + */ +function searchEntity(entity, ul, regExp) { + return new Promise(function(resolve, reject) { + var allMembers = + (entity.members_trait || []) + .concat(entity.members_class || []) + .concat(entity.members_object || []) + + var matchingMembers = $.grep(allMembers, function(member, i) { + return regExp.test(member.label); + }); + + resolve(matchingMembers); + }) + .then(function(res) { + res.forEach(function(elem) { + var kind = document.createElement("span"); + kind.className = "kind"; + kind.appendChild(document.createTextNode(elem.kind)); + + var label = document.createElement("a"); + label.title = elem.label; + label.href = toRoot + elem.link; + label.className = "label"; + label.appendChild(document.createTextNode(elem.label)); + + var tail = document.createElement("span"); + tail.className = "tail"; + tail.appendChild(document.createTextNode(elem.tail)); + + var li = document.createElement("li"); + li.appendChild(kind); + li.appendChild(label); + li.appendChild(tail); + + ul.appendChild(li); + }); + return res; + }); +} + +/** Creates a list item representing an entity + * + * @param {Object} entity, the searched entity to be displayed + * @param {RegExp} regExp + * @return {Node} list item containing entity + */ +function listItem(entity, regExp) { + var name = entity.name.split('.').pop() + var nameElem = document.createElement("span"); + nameElem.className = "entity"; + + var entityUrl = document.createElement("a"); + entityUrl.title = entity.shortDescription ? entity.shortDescription : name; + entityUrl.href = toRoot + entity[entity.kind]; + + entityUrl.appendChild(document.createTextNode(name)); + nameElem.appendChild(entityUrl); + + var iconElem = document.createElement("a"); + iconElem.className = "icon " + entity.kind; + iconElem.title = name + " " + entity.kind; + iconElem.href = toRoot + entity[entity.kind]; + + var li = document.createElement("li"); + li.id = entity.name.replace(new RegExp("\\.", "g"),"-"); + li.appendChild(iconElem); + li.appendChild(nameElem); + + if (entity.kind != "object" && entity.object) { + var companion = document.createElement("a"); + companion.title = name + " companion object"; + companion.href = toRoot + entity.object; + companion.className = "icon object"; + li.insertBefore(companion, iconElem); + } else { + var spacer = document.createElement("div"); + spacer.className = "icon spacer"; + li.insertBefore(spacer, iconElem); + } + + var ul = document.createElement("ul"); + ul.className = "members"; + + li.appendChild(ul); + + return li; +} + +/** Searches all packages and entities for the current search string in + * the input field "#textfilter" + * + * Then shows the results in div#search-results + */ +function searchAll() { + scheduler.clear("search"); // clear previous search + maxJobs = 1; // clear previous max + var searchStr = ($("#textfilter input").val() || '').trim(); + + if (searchStr === '') { + $("div#search-results").hide(); + $("#search > span.close-results").hide(); + $("#search > span#doc-title").show(); + return; + } + + // Replace ?search=X with current search string if not hosted locally on Chrome + try { + window.history.replaceState({}, "", "?search=" + searchStr); + } catch(e) {} + + $("div#results-content > span.search-text").remove(); + + var memberResults = document.getElementById("member-results"); + memberResults.innerHTML = ""; + var memberH1 = document.createElement("h1"); + memberH1.className = "result-type"; + memberH1.innerHTML = "Member results"; + memberResults.appendChild(memberH1); + + var entityResults = document.getElementById("entity-results"); + entityResults.innerHTML = ""; + var entityH1 = document.createElement("h1"); + entityH1.className = "result-type"; + entityH1.innerHTML = "Entity results"; + entityResults.appendChild(entityH1); + + $("div#results-content").prepend( + $("") + .addClass("search-text") + .append(document.createTextNode(" Showing results for ")) + .append($("").addClass("query-str").text(searchStr)) + ); + + var regExp = compilePattern(searchStr); + + // Search for all entities matching query + Index + .keys(Index.PACKAGES) + .sort() + .forEach(function(elem) { searchPackage(elem, regExp); }) +} + +/** Check if user agent is associated with a known mobile browser */ +function isMobile() { + return /Android|webOS|Mobi|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent); +} + +function urlFriendlyEntity(entity) { + var corr = { + '\\+': '$plus', + ':': '$colon' + }; + + for (k in corr) + entity = entity.replace(new RegExp(k, 'g'), corr[k]); + + return entity; +} + +var maxJobs = 1; +function setProgress() { + var running = scheduler.numberOfJobs("search"); + maxJobs = Math.max(maxJobs, running); + + var percent = 100 - (running / maxJobs * 100); + var bar = document.getElementById("progress-fill"); + bar.style.height = "100%"; + bar.style.width = percent + "%"; + + if (percent == 100) { + setTimeout(function() { + bar.style.height = 0; + }, 500); + } +} diff --git a/api/lib/jquery.min.js b/api/lib/jquery.min.js new file mode 100644 index 00000000..e7e29d5b --- /dev/null +++ b/api/lib/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.7.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.0",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+ge+")"+ge+"*"),x=new RegExp(ge+"|>"),j=new RegExp(g),A=new RegExp("^"+t+"$"),D={ID:new RegExp("^#("+t+")"),CLASS:new RegExp("^\\.("+t+")"),TAG:new RegExp("^("+t+"|[*])"),ATTR:new RegExp("^"+p),PSEUDO:new RegExp("^"+g),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ge+"*(even|odd|(([+-]|)(\\d*)n|)"+ge+"*(?:([+-]|)"+ge+"*(\\d+)|))"+ge+"*\\)|)","i"),bool:new RegExp("^(?:"+f+")$","i"),needsContext:new RegExp("^"+ge+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ge+"*((?:-\\d)?\\d*)"+ge+"*\\)|)(?=[^-]|$)","i")},N=/^(?:input|select|textarea|button)$/i,q=/^h\d$/i,L=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,H=/[+~]/,O=new RegExp("\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\([^\\r\\n\\f])","g"),P=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},R=function(){V()},M=J(function(e){return!0===e.disabled&&fe(e,"fieldset")},{dir:"parentNode",next:"legend"});try{k.apply(oe=ae.call(ye.childNodes),ye.childNodes),oe[ye.childNodes.length].nodeType}catch(e){k={apply:function(e,t){me.apply(e,ae.call(t))},call:function(e){me.apply(e,ae.call(arguments,1))}}}function I(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(V(e),e=e||T,C)){if(11!==p&&(u=L.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return k.call(n,a),n}else if(f&&(a=f.getElementById(i))&&I.contains(e,a)&&a.id===i)return k.call(n,a),n}else{if(u[2])return k.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&e.getElementsByClassName)return k.apply(n,e.getElementsByClassName(i)),n}if(!(h[t+" "]||d&&d.test(t))){if(c=t,f=e,1===p&&(x.test(t)||m.test(t))){(f=H.test(t)&&z(e.parentNode)||e)==e&&le.scope||((s=e.getAttribute("id"))?s=ce.escapeSelector(s):e.setAttribute("id",s=S)),o=(l=Y(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+Q(l[o]);c=l.join(",")}try{return k.apply(n,f.querySelectorAll(c)),n}catch(e){h(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return re(t.replace(ve,"$1"),e,n,r)}function W(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function F(e){return e[S]=!0,e}function $(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function B(t){return function(e){return fe(e,"input")&&e.type===t}}function _(t){return function(e){return(fe(e,"input")||fe(e,"button"))&&e.type===t}}function X(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&M(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function U(a){return F(function(o){return o=+o,F(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function z(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}function V(e){var t,n=e?e.ownerDocument||e:ye;return n!=T&&9===n.nodeType&&n.documentElement&&(r=(T=n).documentElement,C=!ce.isXMLDoc(T),i=r.matches||r.webkitMatchesSelector||r.msMatchesSelector,ye!=T&&(t=T.defaultView)&&t.top!==t&&t.addEventListener("unload",R),le.getById=$(function(e){return r.appendChild(e).id=ce.expando,!T.getElementsByName||!T.getElementsByName(ce.expando).length}),le.disconnectedMatch=$(function(e){return i.call(e,"*")}),le.scope=$(function(){return T.querySelectorAll(":scope")}),le.cssHas=$(function(){try{return T.querySelector(":has(*,:jqfake)"),!1}catch(e){return!0}}),le.getById?(b.filter.ID=function(e){var t=e.replace(O,P);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(O,P);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):t.querySelectorAll(e)},b.find.CLASS=function(e,t){if("undefined"!=typeof t.getElementsByClassName&&C)return t.getElementsByClassName(e)},d=[],$(function(e){var t;r.appendChild(e).innerHTML="",e.querySelectorAll("[selected]").length||d.push("\\["+ge+"*(?:value|"+f+")"),e.querySelectorAll("[id~="+S+"-]").length||d.push("~="),e.querySelectorAll("a#"+S+"+*").length||d.push(".#.+[+~]"),e.querySelectorAll(":checked").length||d.push(":checked"),(t=T.createElement("input")).setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),r.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&d.push(":enabled",":disabled"),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||d.push("\\["+ge+"*name"+ge+"*="+ge+"*(?:''|\"\")")}),le.cssHas||d.push(":has"),d=d.length&&new RegExp(d.join("|")),l=function(e,t){if(e===t)return a=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!le.sortDetached&&t.compareDocumentPosition(e)===n?e===T||e.ownerDocument==ye&&I.contains(ye,e)?-1:t===T||t.ownerDocument==ye&&I.contains(ye,t)?1:o?se.call(o,e)-se.call(o,t):0:4&n?-1:1)}),T}for(e in I.matches=function(e,t){return I(e,null,null,t)},I.matchesSelector=function(e,t){if(V(e),C&&!h[t+" "]&&(!d||!d.test(t)))try{var n=i.call(e,t);if(n||le.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){h(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(O,P),e[3]=(e[3]||e[4]||e[5]||"").replace(O,P),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||I.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&I.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return D.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&j.test(n)&&(t=Y(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(O,P).toLowerCase();return"*"===e?function(){return!0}:function(e){return fe(e,t)}},CLASS:function(e){var t=s[e+" "];return t||(t=new RegExp("(^|"+ge+")"+e+"("+ge+"|$)"))&&s(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=I.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function T(e,n,r){return v(n)?ce.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?ce.grep(e,function(e){return e===n!==r}):"string"!=typeof n?ce.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(ce.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||k,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:S.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof ce?t[0]:t,ce.merge(this,ce.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:C,!0)),w.test(r[1])&&ce.isPlainObject(t))for(r in t)v(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=C.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):v(e)?void 0!==n.ready?n.ready(e):e(ce):ce.makeArray(e,this)}).prototype=ce.fn,k=ce(C);var E=/^(?:parents|prev(?:Until|All))/,j={children:!0,contents:!0,next:!0,prev:!0};function A(e,t){while((e=e[t])&&1!==e.nodeType);return e}ce.fn.extend({has:function(e){var t=ce(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,Ce=/^$|^module$|\/(?:java|ecma)script/i;xe=C.createDocumentFragment().appendChild(C.createElement("div")),(be=C.createElement("input")).setAttribute("type","radio"),be.setAttribute("checked","checked"),be.setAttribute("name","t"),xe.appendChild(be),le.checkClone=xe.cloneNode(!0).cloneNode(!0).lastChild.checked,xe.innerHTML="",le.noCloneChecked=!!xe.cloneNode(!0).lastChild.defaultValue,xe.innerHTML="",le.option=!!xe.lastChild;var ke={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function Se(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&fe(e,t)?ce.merge([e],n):n}function Ee(e,t){for(var n=0,r=e.length;n",""]);var je=/<|&#?\w+;/;function Ae(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function Me(e,t){return fe(e,"table")&&fe(11!==t.nodeType?t:t.firstChild,"tr")&&ce(e).children("tbody")[0]||e}function Ie(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function We(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Fe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(_.hasData(e)&&(s=_.get(e).events))for(i in _.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),C.head.appendChild(r[0])},abort:function(){i&&i()}}});var Jt,Kt=[],Zt=/(=)\?(?=&|$)|\?\?/;ce.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Kt.pop()||ce.expando+"_"+jt.guid++;return this[e]=!0,e}}),ce.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Zt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Zt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=v(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Zt,"$1"+r):!1!==e.jsonp&&(e.url+=(At.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||ce.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=ie[r],ie[r]=function(){o=arguments},n.always(function(){void 0===i?ce(ie).removeProp(r):ie[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Kt.push(r)),o&&v(i)&&i(o[0]),o=i=void 0}),"script"}),le.createHTMLDocument=((Jt=C.implementation.createHTMLDocument("").body).innerHTML="
",2===Jt.childNodes.length),ce.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(le.createHTMLDocument?((r=(t=C.implementation.createHTMLDocument("")).createElement("base")).href=C.location.href,t.head.appendChild(r)):t=C),o=!n&&[],(i=w.exec(e))?[t.createElement(i[1])]:(i=Ae([e],t,o),o&&o.length&&ce(o).remove(),ce.merge([],i.childNodes)));var r,i,o},ce.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(ce.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},ce.expr.pseudos.animated=function(t){return ce.grep(ce.timers,function(e){return t===e.elem}).length},ce.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=ce.css(e,"position"),c=ce(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=ce.css(e,"top"),u=ce.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),v(t)&&(t=t.call(e,n,ce.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},ce.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){ce.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===ce.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===ce.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=ce(e).offset()).top+=ce.css(e,"borderTopWidth",!0),i.left+=ce.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-ce.css(r,"marginTop",!0),left:t.left-i.left-ce.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===ce.css(e,"position"))e=e.offsetParent;return e||J})}}),ce.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;ce.fn[t]=function(e){return R(this,function(e,t,n){var r;if(y(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),ce.each(["top","left"],function(e,n){ce.cssHooks[n]=Ye(le.pixelPosition,function(e,t){if(t)return t=Ge(e,n),_e.test(t)?ce(e).position()[n]+"px":t})}),ce.each({Height:"height",Width:"width"},function(a,s){ce.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){ce.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return R(this,function(e,t,n){var r;return y(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?ce.css(e,t,i):ce.style(e,t,n,i)},s,n?e:void 0,n)}})}),ce.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){ce.fn[t]=function(e){return this.on(t,e)}}),ce.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),ce.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){ce.fn[n]=function(e,t){return 0 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + O + + + + + + + diff --git a/api/lib/object_comp.svg b/api/lib/object_comp.svg new file mode 100644 index 00000000..0434243f --- /dev/null +++ b/api/lib/object_comp.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + O + + + + + + + + diff --git a/api/lib/object_comp_annotation.svg b/api/lib/object_comp_annotation.svg new file mode 100644 index 00000000..bccf6caf --- /dev/null +++ b/api/lib/object_comp_annotation.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + O + + + + + + + + diff --git a/api/lib/object_comp_trait.svg b/api/lib/object_comp_trait.svg new file mode 100644 index 00000000..56eccd03 --- /dev/null +++ b/api/lib/object_comp_trait.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + O + + + + + + + + diff --git a/api/lib/object_diagram.png b/api/lib/object_diagram.png new file mode 100644 index 00000000..6e9f2f74 Binary files /dev/null and b/api/lib/object_diagram.png differ diff --git a/api/lib/open-sans-v13-latin-400i.eot b/api/lib/open-sans-v13-latin-400i.eot new file mode 100644 index 00000000..81e597a2 Binary files /dev/null and b/api/lib/open-sans-v13-latin-400i.eot differ diff --git a/api/lib/open-sans-v13-latin-400i.ttf b/api/lib/open-sans-v13-latin-400i.ttf new file mode 100644 index 00000000..e6c54141 Binary files /dev/null and b/api/lib/open-sans-v13-latin-400i.ttf differ diff --git a/api/lib/open-sans-v13-latin-400i.woff b/api/lib/open-sans-v13-latin-400i.woff new file mode 100644 index 00000000..c13ef910 Binary files /dev/null and b/api/lib/open-sans-v13-latin-400i.woff differ diff --git a/api/lib/open-sans-v13-latin-700.eot b/api/lib/open-sans-v13-latin-700.eot new file mode 100644 index 00000000..748774fe Binary files /dev/null and b/api/lib/open-sans-v13-latin-700.eot differ diff --git a/api/lib/open-sans-v13-latin-700.ttf b/api/lib/open-sans-v13-latin-700.ttf new file mode 100644 index 00000000..7b529456 Binary files /dev/null and b/api/lib/open-sans-v13-latin-700.ttf differ diff --git a/api/lib/open-sans-v13-latin-700.woff b/api/lib/open-sans-v13-latin-700.woff new file mode 100644 index 00000000..ec478e57 Binary files /dev/null and b/api/lib/open-sans-v13-latin-700.woff differ diff --git a/api/lib/open-sans-v13-latin-700i.eot b/api/lib/open-sans-v13-latin-700i.eot new file mode 100644 index 00000000..5dbb39a5 Binary files /dev/null and b/api/lib/open-sans-v13-latin-700i.eot differ diff --git a/api/lib/open-sans-v13-latin-700i.ttf b/api/lib/open-sans-v13-latin-700i.ttf new file mode 100644 index 00000000..a670e142 Binary files /dev/null and b/api/lib/open-sans-v13-latin-700i.ttf differ diff --git a/api/lib/open-sans-v13-latin-700i.woff b/api/lib/open-sans-v13-latin-700i.woff new file mode 100644 index 00000000..808621a5 Binary files /dev/null and b/api/lib/open-sans-v13-latin-700i.woff differ diff --git a/api/lib/open-sans-v13-latin-regular.eot b/api/lib/open-sans-v13-latin-regular.eot new file mode 100644 index 00000000..1d98e6ea Binary files /dev/null and b/api/lib/open-sans-v13-latin-regular.eot differ diff --git a/api/lib/open-sans-v13-latin-regular.ttf b/api/lib/open-sans-v13-latin-regular.ttf new file mode 100644 index 00000000..0dae9c3b Binary files /dev/null and b/api/lib/open-sans-v13-latin-regular.ttf differ diff --git a/api/lib/open-sans-v13-latin-regular.woff b/api/lib/open-sans-v13-latin-regular.woff new file mode 100644 index 00000000..e096d04f Binary files /dev/null and b/api/lib/open-sans-v13-latin-regular.woff differ diff --git a/api/lib/ownderbg2.gif b/api/lib/ownderbg2.gif new file mode 100644 index 00000000..848dd596 Binary files /dev/null and b/api/lib/ownderbg2.gif differ diff --git a/api/lib/ownerbg.gif b/api/lib/ownerbg.gif new file mode 100644 index 00000000..34a04249 Binary files /dev/null and b/api/lib/ownerbg.gif differ diff --git a/api/lib/ownerbg2.gif b/api/lib/ownerbg2.gif new file mode 100644 index 00000000..2ed33b0a Binary files /dev/null and b/api/lib/ownerbg2.gif differ diff --git a/api/lib/package.svg b/api/lib/package.svg new file mode 100644 index 00000000..63f581b3 --- /dev/null +++ b/api/lib/package.svg @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + p + + + + + + + diff --git a/api/lib/print.css b/api/lib/print.css new file mode 100644 index 00000000..16ca6a7c --- /dev/null +++ b/api/lib/print.css @@ -0,0 +1,11 @@ +@media print { + * { + text-decoration: none; + font-family: "Lato", Arial, sans-serif; + border-width: 0px; + margin: 0px; + } + #textfilter, #package, #subpackage-spacer, #memberfilter, #filterby, div#definition .big-circle { + display: none !important; + } +} diff --git a/api/lib/ref-index.css b/api/lib/ref-index.css new file mode 100644 index 00000000..7cdcd9de --- /dev/null +++ b/api/lib/ref-index.css @@ -0,0 +1,56 @@ +/* fonts */ +@font-face { + font-family: 'Source Code Pro'; + font-style: normal; + font-weight: 400; + src: url('http://github.com/source-code-pro-v6-latin-regular.eot'); + src: local('Source Code Pro'), local('SourceCodePro-Regular'), + url('http://github.com/source-code-pro-v6-latin-regular.eot?#iefix') format('embedded-opentype'), + url('http://github.com/source-code-pro-v6-latin-regular.woff') format('woff'), + url('http://github.com/source-code-pro-v6-latin-regular.ttf') format('truetype'); +} +@font-face { + font-family: 'Source Code Pro'; + font-style: normal; + font-weight: 700; + src: url('http://github.com/source-code-pro-v6-latin-700.eot'); + src: local('Source Code Pro Bold'), local('SourceCodePro-Bold'), + url('http://github.com/source-code-pro-v6-latin-700.eot?#iefix') format('embedded-opentype'), + url('http://github.com/source-code-pro-v6-latin-700.woff') format('woff'), + url('http://github.com/source-code-pro-v6-latin-700.ttf') format('truetype'); +} + +body { + font-size: 10pt; + font-family: Arial, sans-serif; +} + +a { + color:#315479; +} + +.letters { + width:100%; + text-align:center; + margin:0.6em; + padding:0.1em; + border-bottom:1px solid gray; +} + +div.entry { + padding: 0.5em; + background-color: #e1e7ed; + border-radius: 0.2em; + color: #103a51; + margin: 0.5em 0; +} + +.name { + font-family: "Source Code Pro"; + font-size: 1.1em; +} + +.occurrences { + margin-left: 1em; + margin-top: 5px; +} diff --git a/api/lib/scheduler.js b/api/lib/scheduler.js new file mode 100644 index 00000000..eb396bb5 --- /dev/null +++ b/api/lib/scheduler.js @@ -0,0 +1,108 @@ +// © 2010 EPFL/LAMP +// code by Gilles Dubochet, Felix Mulder + +function Scheduler() { + var scheduler = this; + var resolution = 0; + this.timeout = undefined; + this.queues = new Array(0); // an array of work packages indexed by index in the labels table. + this.labels = new Array(0); // an indexed array of labels indexed by priority. This should be short. + + this.label = function(name, priority) { + this.name = name; + this.priority = priority; + } + + this.work = function(fn, self, args) { + this.fn = fn; + this.self = self; + this.args = args; + } + + this.addLabel = function(name, priority) { + var idx = 0; + while (idx < scheduler.queues.length && scheduler.labels[idx].priority <= priority) { idx = idx + 1; } + scheduler.labels.splice(idx, 0, new scheduler.label(name, priority)); + scheduler.queues.splice(idx, 0, new Array(0)); + } + + this.clearLabel = function(name) { + var idx = scheduler.indexOf(name); + if (idx != -1) { + scheduler.labels.splice(idx, 1); + scheduler.queues.splice(idx, 1); + } + } + + this.nextWork = function() { + var fn = undefined; + var idx = 0; + while (idx < scheduler.queues.length && scheduler.queues[idx].length == 0) { idx = idx + 1; } + + if (idx < scheduler.queues.length && scheduler.queues[idx].length > 0) + var fn = scheduler.queues[idx].shift(); + + return fn; + } + + this.add = function(labelName, fn, self, args) { + var doWork = function() { + scheduler.timeout = setTimeout(function() { + var work = scheduler.nextWork(); + if (work != undefined) { + if (work.args == undefined) { work.args = new Array(0); } + work.fn.apply(work.self, work.args); + doWork(); + } + else { + scheduler.timeout = undefined; + } + }, resolution); + } + + var idx = scheduler.indexOf(labelName) + if (idx != -1) { + scheduler.queues[idx].push(new scheduler.work(fn, self, args)); + if (scheduler.timeout == undefined) doWork(); + } else { + throw("queue for add is non-existent"); + } + } + + this.clear = function(labelName) { + scheduler.queues[scheduler.indexOf(labelName)] = new Array(); + } + + this.indexOf = function(label) { + var idx = 0; + while (idx < scheduler.labels.length && scheduler.labels[idx].name != label) + idx++; + + return idx < scheduler.queues.length && scheduler.labels[idx].name == label ? idx : -1; + } + + this.queueEmpty = function(label) { + var idx = scheduler.indexOf(label); + if (idx != -1) + return scheduler.queues[idx].length == 0; + else + throw("queue for label '" + label + "' is non-existent"); + } + + this.scheduleLast = function(label, fn) { + if (scheduler.queueEmpty(label)) { + fn(); + } else { + scheduler.add(label, function() { + scheduler.scheduleLast(label, fn); + }); + } + } + + this.numberOfJobs = function(label) { + var index = scheduler.indexOf(label); + if (index == -1) throw("queue for label '" + label + "' non-existent"); + + return scheduler.queues[index].length; + } +}; diff --git a/api/lib/source-code-pro-v6-latin-700.eot b/api/lib/source-code-pro-v6-latin-700.eot new file mode 100644 index 00000000..094e578e Binary files /dev/null and b/api/lib/source-code-pro-v6-latin-700.eot differ diff --git a/api/lib/source-code-pro-v6-latin-700.ttf b/api/lib/source-code-pro-v6-latin-700.ttf new file mode 100644 index 00000000..04159884 Binary files /dev/null and b/api/lib/source-code-pro-v6-latin-700.ttf differ diff --git a/api/lib/source-code-pro-v6-latin-700.woff b/api/lib/source-code-pro-v6-latin-700.woff new file mode 100644 index 00000000..6ac8a3b2 Binary files /dev/null and b/api/lib/source-code-pro-v6-latin-700.woff differ diff --git a/api/lib/source-code-pro-v6-latin-regular.eot b/api/lib/source-code-pro-v6-latin-regular.eot new file mode 100644 index 00000000..60bd73b5 Binary files /dev/null and b/api/lib/source-code-pro-v6-latin-regular.eot differ diff --git a/api/lib/source-code-pro-v6-latin-regular.ttf b/api/lib/source-code-pro-v6-latin-regular.ttf new file mode 100644 index 00000000..268a2e43 Binary files /dev/null and b/api/lib/source-code-pro-v6-latin-regular.ttf differ diff --git a/api/lib/source-code-pro-v6-latin-regular.woff b/api/lib/source-code-pro-v6-latin-regular.woff new file mode 100644 index 00000000..7daeecc8 Binary files /dev/null and b/api/lib/source-code-pro-v6-latin-regular.woff differ diff --git a/api/lib/template.css b/api/lib/template.css new file mode 100644 index 00000000..12974477 --- /dev/null +++ b/api/lib/template.css @@ -0,0 +1,1236 @@ +/* Reset */ + +html, body, div, span, object, iframe, +h1, h2, h3, h4, h5, h6, p, blockquote, pre, +a, abbr, acronym, address, code, pre, +del, dfn, em, img, q, dl, dt, dd, ol, ul, li, +fieldset, form, label, legend, input, +table, caption, tbody, tfoot, thead, tr, th, td { + margin: 0; + padding: 0; + border: 0; + font-weight: inherit; + font-style: inherit; + font-size: 100%; + font-family: inherit; + vertical-align: baseline; +} + +table { border-collapse: separate; border-spacing: 0; } +caption, th, td { text-align: left; font-weight: normal; } +table, td, th { vertical-align: middle; } + +textarea, input { outline: none; } + +blockquote:before, blockquote:after, q:before, q:after { content: ""; } +blockquote, q { quotes: none; } + +a img { border: none; } + +input { border-width: 0px; } + +/* Page */ +body { + overflow-x: hidden; + font-family: Arial, sans-serif; + background-color: #f0f3f6; +} + +#footer { + text-align: center; + color: #858484; + bottom: 0; + min-height: 20px; + margin: 0 1em 0.5em; +} + +#content-container a[href] { + text-decoration: underline; + color: #315479; +} + +#content-container a[href]:hover { + text-decoration: none; +} + +#types ol li > p { + margin-top: 5px; +} + +#types ol li:last-child { + margin-bottom: 5px; +} + +#definition { + position: relative; + display: block; + padding: 5px 0; + padding: 0; + margin: 0.5em; + min-height: 4.72em; +} + +#definition > a > img { + float: left; + padding-right: 6px; + padding-left: 5px; +} + +#definition p + h1 { + margin-top: 3px; +} + +#definition > h1 { + float: left; + color: #103a51; + display: inline-block; + overflow: hidden; + margin-top: 10px; + font-size: 2.0em; +} + +#definition h1 > a { + color: #103a51 !important; + text-decoration: none !important; +} + +#template ol > li > span.permalink > a > i { + transform: rotate(-45deg); +} + +#definition #owner { + color: #103a51; + padding-top: 1.3em; + font-size: 0.8em; + overflow: hidden; +} + +#definition > h3 { + margin-top: 0.85em; + padding: 0; +} + +#definition #owner > a { + color: #103a51; +} + +#definition #owner > a:hover { + text-decoration: none; +} + +#signature { + background-color: #c2d2dc; + min-height: 18px; + font-size: 0.9em; + padding: 8px; + color: #103a51; + border-radius: 0.2em; + margin: 0 0.5rem; +} + +#signature > span.modifier_kind { + display: inline; + float: left; + text-align: left; + width: auto; + position: static; + padding-left: 0; +} + +span.symbol > a { + display: inline-block; +} + +#signature > span.symbol { + text-align: left; + display: inline; + padding-left: 0.7em; +} + +/* Linear super types and known subclasses */ +.hiddenContent { + display: none; +} + +.toggleContainer .toggle { + position: relative; + color: #103a51; + margin-left: 0.3em; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.toggleContainer .toggle > i { + position: absolute; + left: -1.5em; + top: 0em; + font-size: 1.3em; + transition: 0.1s; +} + +.toggleContainer .toggle.open > i { + transform: rotate(90deg); +} + +.toggleContainer .hiddenContent { + margin-top: 1.5em; +} + +#memberfilter > i.arrow { + position: absolute; + top: 0.45em; + left: -0.9em; + color: #fff; + font-size: 1.3em; + opacity: 0; + transition: 0.1s; + cursor: pointer; +} + +#memberfilter > i.arrow.rotate { + transform: rotate(90deg); +} + +#memberfilter:hover > i.arrow { + opacity: 1; +} + +.big-circle { + box-sizing: content-box; + height: 5.7em; + width: 5.7em; + float: left; + color: transparent; +} + +.big-circle:hover { + background-size: 5.7em; +} + +.big-circle.class { + background: url("http://github.com/class.svg") no-repeat center; +} + +.big-circle.class-companion-object { + background: url("http://github.com/class_comp.svg") no-repeat center; +} + +.big-circle.object-companion-class { + background: url("http://github.com/object_comp.svg") no-repeat center; +} + +.big-circle.trait-companion-object { + background: url("http://github.com/trait_comp.svg") no-repeat center; +} + +.big-circle.object-companion-trait { + background: url("http://github.com/object_comp_trait.svg") no-repeat center; +} + +.big-circle.object { + background: url("http://github.com/object.svg") no-repeat center; +} + +.big-circle.trait { + background: url("http://github.com/trait.svg") no-repeat center; +} + +.big-circle.package { + background: url("http://github.com/package.svg") no-repeat center; +} + +.big-circle.annotation { + background: url("http://github.com/annotation.svg") no-repeat center; +} + +.big-circle.object-companion-annotation { + background: url("http://github.com/object_comp_annotation.svg") no-repeat center; +} + +.big-circle.annotation-companion-object { + background: url("http://github.com/annotation_comp.svg") no-repeat center; +} + +body.abstract.type div.big-circle { + background: url("http://github.com/abstract_type.svg") no-repeat center; +} + +body.alias.type div.big-circle { + background: url("http://github.com/abstract_type.svg") no-repeat center; +} + +#template { + margin: 0.9em 0.75em 0.75em; + padding-bottom: 0.5em; +} + +#template h3 { + color: #103a51; + height: 2em; + padding: 1em 1em 2em; + font-size: 1.2em; +} + +#order { + margin-top: 1.5em; +} + +h3 { + color: #103a51; + padding: 5px 10px; + font-size: 1em; + font-weight: bold; +} + +dl.attributes > dt { + display: block; + float: left; + font-style: italic; + font-weight: bold; +} + +dl.attributes > dt.implicit { + font-weight: bold; + color: darkgreen; +} + +dl.attributes > dd { + display: block; + padding-left: 10em; + margin-bottom: 5px; + min-height: 15px; +} + +.values ol li:last-child { + margin-bottom: 5px; +} + +#constructors > h3 { + height: 2em; + padding: 1em 1em 2em; + color: #2C475C; +} + +#inheritedMembers > div.parent > h3 { + height: 17px; + font-style: italic; +} + +#inheritedMembers > div.parent > h3 * { + color: white; +} + +#inheritedMembers > div.conversion > h3 { + height: 2em; + padding: 1em; + font-style: italic; + color: #2C475C; +} + +#groupedMembers > div.group > h3 { + color: #2C475C; + height: 2em; + padding: 1em 1em 2em; +} + +/* Member cells */ +div.members > ol { + list-style: none; +} + +div.members > ol > li { + display: table; + width: 100%; + position: relative; + background-color: #fff; + border-radius: 0.2em; + color: #103a51; + padding: 5px 0 5px; + margin-bottom: 0.4em; + min-height: 3.7em; + border-left: 0.25em solid white; + -webkit-box-shadow: 0 0 10px rgba(0,0,0,0.1); + box-shadow: 0 0 10px rgba(0,0,0,0.1); + transition: 0.1s; +} + +div.members > ol >li.selected, +div.members > ol > li:hover { + background-color: #dae7f0; + border-left-color: #dae7f0; +} + +div.members > ol >li[fullComment=yes].selected, +div.members > ol > li[fullComment=yes]:hover { + cursor: pointer; + border-left: 0.25em solid #72D0EB; +} + +div.members > ol > li:last-child { + padding: 5px 0 5px; +} + +/* Member signatures */ + +#tooltip { + background: #EFD5B5; + border: 1px solid gray; + color: black; + display: none; + padding: 5px; + position: absolute; +} + +.signature { + font-family: "Source Code Pro", "Monaco", "Ubuntu Mono Regular", "Lucida Console", monospace; + font-size: 0.8rem; + line-height: 18px; + clear: both; + display: block; +} + +.modifier_kind { + font-family: "Source Code Pro", "Monaco", "Ubuntu Mono Regular", "Lucida Console", monospace; + font-size: 0.8rem; + padding-right: 0.5em; + text-align: right; + display: table-cell; + white-space: nowrap; + width: 16em; +} + +.symbol { + font-family: "Source Code Pro", "Monaco", "Ubuntu Mono Regular", "Lucida Console", monospace; +} + +a > .symbol > .name { + text-decoration: underline; +} + +a:hover > .symbol > .name { + text-decoration: none; +} + +.signature > a { + text-decoration: none; +} + +.signature > .symbol { + display: inline; +} + +.signature .name { + display: inline-block; + font-weight: bold; +} + +span.symbol > span.name { + font-weight: bold; +} + +#types > ol > li > span.symbol > span.result { + display: none; +} + +#types > ol > li > span.symbol > span.result.alias, +#types > ol > li:hover > span.symbol > span.result, +#types > ol > li.open > span.symbol > span.result { + display: inline; +} + +.symbol > .implicit { + display: inline-block; + font-weight: bold; + text-decoration: underline; + color: darkgreen; +} + +.symbol .shadowed { + color: darkseagreen; +} + +.symbol .params > .implicit { + font-style: italic; +} + +.symbol .deprecated { + text-decoration: line-through; +} + +.symbol .params .default { + font-style: italic; +} + +#template .closed { + cursor: pointer; +} + +#template .opened { + cursor: pointer; +} + +i.unfold-arrow { + font-size: 1em; + position: absolute; + top: 0.55em; + left: 0.7em; + transition: 0.1s; +} + +#template .modifier_kind.opened > i.unfold-arrow { + transform: rotate(90deg); +} + +#template .values .name { + font-weight: 600; + color: #315479; +} + +#template .types .name { + font-weight: 600; + color: darkgreen; +} + +.full-signature-usecase h4 span { + font-size: 0.8rem; +} + +.full-signature-usecase > #signature { + padding-top: 0px; + position: relative; + top: 0; +} + +/* Hide unfold arrow where appropriate */ +#template li[fullComment=no] .modifier_kind > i.unfold-arrow, +div#definition > h4#signature > span.modifier_kind > i.unfold-arrow, +.full-signature-usecase > .signature > .closed > i.unfold-arrow, +.full-signature-usecase > .signature > .opened > i.unfold-arrow { + display: none; +} + +#template .full-signature-usecase > .signature > .closed { + background: none; +} + +#template .full-signature-usecase > .signature > .opened { + background: none; +} + +.full-signature-block { + padding: 5px 0 0; + border-top: 1px solid #EBEBEB; + margin-top: 5px; + margin-bottom: 5px; +} + +#definition .morelinks { + text-align: right; + font-family: "Source Code Pro", "Monaco", "Ubuntu Mono Regular", "Lucida Console", monospace; +} + +#definition .morelinks a { + color: #103a51; +} + +#template .members li .permalink { + position: absolute; + left: 0.25em; + top: 0.95em; +} + +#definition .permalink { + display: none; + color: black; +} + +#definition .permalink a { + color: #103a51; + transform: rotate(-45deg); +} + +#definition > h1 > span > a > i { + font-size: 1.4rem; +} + +#template ol > li > span.permalink > a > i { + color: #fff; +} + +#template .members li .permalink, +#definition .permalink a { + display: none; +} + +#template .members li:hover .permalink, +#definition:hover .permalink a { + display: block; +} + +#template .members li .permalink a, +#definition .permalink a { + text-decoration: none; + font-weight: bold; +} + +/* Comments text formatting */ + +.cmt { + color: #103a51; +} + +.cmt p { + margin: 0.7em 0; +} + +.cmt p:first-child { + margin-top: 0; +} + +.cmt p:last-child { + margin-bottom: 0; +} + +.cmt h3, +.cmt h4, +.cmt h5, +.cmt h6 { + margin-bottom: 0.7em; + margin-top: 1.4em; + display: block; + text-align: left; + font-weight: bold; +} + +.cmt pre { + padding: 0.5em; + border: 0px solid #ddd; + background-color: #fff; + margin: 5px 0; + display: block; + font-family: "Source Code Pro", "Monaco", "Ubuntu Mono Regular", "Lucida Console", monospace; + border-radius: 0.2em; + overflow-x: auto; +} + +.cmt pre span.ano { + color: blue; +} + +.cmt pre span.cmt { + color: green; +} + +.cmt pre span.kw { + font-weight: bold; +} + +.cmt pre span.lit { + color: #c71585; +} + +.cmt pre span.num { + color: #1e90ff; /* dodgerblue */ +} + +.cmt pre span.std { + color: #008080; /* teal */ +} + +.cmt ul { + display: block; + list-style: circle; + padding-left: 20px; +} + +.cmt ol { + display: block; + padding-left:20px; +} + +.cmt ol.decimal { + list-style: decimal; +} + +.cmt ol.lowerAlpha { + list-style: lower-alpha; +} + +.cmt ol.upperAlpha { + list-style: upper-alpha; +} + +.cmt ol.lowerRoman { + list-style: lower-roman; +} + +.cmt ol.upperRoman { + list-style: upper-roman; +} + +.cmt li { + display: list-item; +} + +.cmt code { + font-family: "Source Code Pro", "Monaco", "Ubuntu Mono Regular", "Lucida Console", monospace; +} + +.cmt a { + font-style: bold; +} + +.cmt em, .cmt i { + font-style: italic; +} + +.cmt strong, .cmt b { + font-weight: bold; +} + +/* Comments structured layout */ + +.group > div.comment { + display: block; + padding: 0 1.2em 1em; + font-family: "Open Sans"; +} + +p.comment { + display: block; + margin-left: 14.7em; + margin-top: 5px; +} + +.shortcomment { + display: block; + margin: 5px 10px; +} + +.shortcomment > span.badge { + display: block; + position: absolute; + right: 0; + top: 0.7em; +} + +div.fullcommenttop { + padding: 1em 0.8em; +} + +div.fullcomment { + margin: 5px 10px; +} + +#template div.fullcommenttop, +#template div.fullcomment { + display:none; + margin: 0.5em 1em 0 0; +} + +#template .shortcomment { + margin: 5px 0 0 0; + padding: 0; + font-family: "Open Sans"; +} + +div.fullcomment .block { + padding: 5px 0 0; + border-top: 2px solid #fff; + margin-top: 5px; + overflow: hidden; + font-family: "Open Sans"; +} + +div.fullcommenttop .block { + position: relative; + padding: 1em; + margin: 0.5em 0; + border-radius: 0.2em; + background-color: #fff; + -webkit-box-shadow: 0 0 10px rgba(0,0,0,0.1); + box-shadow: 0 0 10px rgba(0,0,0,0.1); +} + +div.fullcommenttop .toggleContainer { + border-left: 0 solid #72D0EB; + transition: 0.1s; + cursor: pointer; +} + +div.fullcommenttop .toggleContainer:hover { + border-left: 0.25em solid #72D0EB; +} + +div#comment, +div#mbrsel, +div#template, +div#footer { + font-size: 0.8em; +} + +#comment { + font-family: "Open Sans"; +} + +#comment > dl { + background: transparent; + -webkit-box-shadow: none; + box-shadow: none; +} + +#comment > dl > div > ol { + list-style-type: none; +} + +div.fullcomment div.block ol li p, +div.fullcomment div.block ol li { + display:inline +} + +div.fullcomment .block > h5 { + font-style: italic; + font-weight: normal; + display: inline-block; +} + +div.fullcomment .comment { + font-family: "Open Sans"; + margin: 5px 0 10px; +} + +div.fullcommenttop .comment:last-child, +div.fullcomment .comment:last-child { + margin-bottom: 0; +} + +div.fullcommenttop dl.paramcmts { + margin-bottom: 0.8em; + padding-bottom: 0.8em; +} + +div.fullcommenttop dl.paramcmts > dt, +div.fullcomment dl.paramcmts > dt { + display: block; + float: left; + font-weight: bold; + min-width: 70px; +} + +div.fullcommenttop dl.paramcmts > dd, +div.fullcomment dl.paramcmts > dd { + display: block; + padding-left: 10px; + margin-bottom: 5px; + margin-left: 70px; + min-height: 15px; +} + +/* Author Content Table formatting */ + +.doctbl { + border-collapse: collapse; + margin: 1.0em 0em; +} + +.doctbl-left { + text-align: left; +} + +.doctbl-center { + text-align: center; +} + +.doctbl-right { + text-align: right; +} + +table.doctbl th { + border: 1px dotted #364550; + background-color: #c2d2dc; + padding: 5px; + color: #103a51; + font-weight: bold; +} + +table.doctbl td { + border: 1px dotted #364550; + padding: 5px; +} + +/* Members filter tool */ + +#memberfilter { + position: relative; + display: block; + height: 2.7em; + margin-bottom: 5px; + margin-left: 1.5em; +} + +#memberfilter > .input { + display: block; + position: absolute; + top: 0; + left: -1.65em; + right: -0.2em; + transition: 0.2s; +} + +#memberfilter > .input > input { + color: #fff; + width: 100%; + border-radius: 0.2em; + padding: 0.5em; + background: rgba(255, 255, 255, 0.2); + font-family: "Open Sans"; +} + +#memberfilter > .input > input::-webkit-input-placeholder { + color: #fff; + opacity: 0.6; +} +#memberfilter > .input > input:-ms-input-placeholder { + color: #fff; + opacity: 0.6; +} +#memberfilter > .input > input::placeholder { + color: #fff; + opacity: 0.6; +} + +#memberfilter > .clear { + display: none; + position: absolute; + top: 0.55em; + color: rgba(255, 255, 255, 0.4); + right: 0; + font-size: 1.2em; +} + +#memberfilter > .clear:hover { + color: #fff; + cursor: pointer; +} + +#mbrsel { + display: block; + padding: 1em 1em 0.5em; + margin: 0.8em; + border-radius: 0.2em; + background-color: #364550; + -webkit-box-shadow: 0 0 10px rgba(0,0,0,0.2); + box-shadow: 0 0 10px rgba(0,0,0,0.2); + position: relative; +} + +#mbrsel > div.toggle { + opacity: 0; + position: absolute; + left: 1.85em; + top: 1.75em; + width: 1em; + height: 1em; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + transition: 0.2s; +} + +#mbrsel:hover > div.toggle { + opacity: 1; +} + +#mbrsel:hover #memberfilter > .input { + left: 0.7em; +} + +#mbrsel > div.toggle > i { + cursor: pointer; + position: absolute; + left: 0; + top: 0; + color: #fff; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +#mbrsel > div.toggle.open > i { + transform: rotate(90deg); +} + +#mbrsel > div#filterby { + display: none; +} + +#mbrsel > div#filterby > div { + margin-bottom: 5px; +} + +#mbrsel > div#filterby > div:last-child { + margin-bottom: 0; +} + +#mbrsel > div#filterby > div > span.filtertype { + color: #fff; + padding: 4px; + margin-right: 1em; + float: left; + display: inline-block; + font-weight: bold; + width: 4.5em; +} + +#mbrsel > div#filterby > div > ol { + display: inline-block; +} + +#mbrsel > div#filterby > div > a { + position:relative; + top: -8px; + font-size: 11px; +} + +#mbrsel > div#filterby > div > ol#linearization { + display: table; + margin-left: 70px; +} + +#mbrsel > div#filterby > div > ol#linearization > li.in { + text-decoration: none; + float: left; + margin-right: 5px; + background-position: right 0px; +} + +#mbrsel > div#filterby > div > ol#linearization > li.in > span{ + float: left; +} + +#mbrsel > div#filterby > div > ol#implicits { + display: table; + margin-left: 70px; +} + +#mbrsel > div#filterby > div > ol#implicits > li { + text-decoration: none; + float: left; + margin: 0.4em 0.4em 0.4em 0; +} + +#mbrsel > div#filterby > div > ol#implicits > li.in { + text-decoration: none; + float: left; +} + +#mbrsel > div#filterby > div > ol#implicits > li.in > span{ + float: left; +} + +#mbrsel > div#filterby > div > ol > li { + line-height: 1.5em; + display: inline-block; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +#mbrsel > div#filterby > div > ol > li.in { + text-decoration: none; + float: left; + margin-right: 5px; + + font-size: 0.8em; + -webkit-border-radius: 0.2em; + border-radius: 0.2em; + padding: 5px 15px; + cursor: pointer; + background: #f16665; + border-bottom: 2px solid #d64546; + color: #fff; + font-weight: 700; +} + +#mbrsel > div#filterby > div > ol > li.in > span{ + float: left; +} + +#mbrsel > div#filterby > div > ol > li.out { + text-decoration: none; + float: left; + padding-right: 10px; + margin-right: 5px; + font-size: 0.8em; + -webkit-border-radius: 0.2em; + border-radius: 0.2em; + padding: 5px 15px; + cursor: pointer; + background: #c2d2dc; + border-bottom: 2px solid rgba(0, 0, 0, 0.1); + color: #103a51; + font-weight: 700; +} + +#mbrsel > div#filterby > div > ol > li.out > span{ + float: left; +} + +.badge { + display: inline-block; + padding: 0.3em 1em; + font-size: 0.8em; + font-weight: bold; + color: #ffffff; + white-space: nowrap; + vertical-align: middle; + background-color: #999999; + -webkit-border-radius: 9px; + -moz-border-radius: 9px; + border-radius: 1em; + font-family: "Open Sans"; +} + +.badge-red { + background-color: #b94a48; + margin-right: 0.8em !important; +} + +/* Media query rules for smaller viewport */ +@media only screen /* Large screen with a small window */ +and (max-width: 650px) +, +screen /* HiDPI device like Nexus 5 */ +and (max-device-width: 360px) +and (max-device-height: 640px) +and (-webkit-device-pixel-ratio: 3) +, +screen /* Most mobile devices */ +and (max-device-width: 480px) +and (orientation: portrait) +, +only screen /* iPhone 6 */ +and (max-device-width: 667px) +and (-webkit-device-pixel-ratio: 2) +{ + body, + body > h4#signature { + min-width: 300px; + } + + #template .modifier_kind { + width: 1px; + padding-left: 2.5em; + } + + span.modifier_kind > span.modifier { + display: none; + } + + #definition { + height: 6em; + } + + #definition > h1 { + font-size: 1em; + margin-right: 0.3em; + } + + #definition > h3 { + float: left; + margin: 0.3em 0; + } + + #definition > #owner { + padding-top: 2.6em; + } + + #definition .morelinks { + text-align: left; + font-size: 0.8em; + } + + .big-circle { + margin-top: 0.6em; + } +} + +/* Media query rules specifically for mobile devices */ +@media +screen /* HiDPI device like Nexus 5 */ +and (max-device-width: 360px) +and (max-device-height: 640px) +and (-webkit-device-pixel-ratio: 3) +, +screen /* Most mobile devices */ +and (max-device-width: 480px) +and (orientation: portrait) +, +only screen /* iPhone 6 */ +and (max-device-width: 667px) +and (-webkit-device-pixel-ratio: 2) +{ + #signature { + font-size: 0.7em; + } + + #definition > h1 { + font-size: 1.3em; + } + + #definition .morelinks { + display: none; + } + + #definition #owner { + padding-top: 0.7em; + } + + #signature > span.modifier_kind { + width: auto; + } + + div.fullcomment dl.attributes > dt { + margin: 0.5em 0; + clear: both; + } + + div.fullcomment dl.attributes > dd { + padding-left: 0; + clear: both; + } + + .big-circle { + width: 3em; + height: 3em; + background-size: 3em !important; + margin: 0.5em; + } + + div#template { + margin-bottom: 0.5em; + } + + div#footer { + font-size: 0.5em; + } + + .shortcomment > span.badge { + display: none; + } +} diff --git a/api/lib/template.js b/api/lib/template.js new file mode 100644 index 00000000..e8b44e9b --- /dev/null +++ b/api/lib/template.js @@ -0,0 +1,543 @@ +// © 2009–2010 EPFL/LAMP +// code by Gilles Dubochet with contributions by Pedro Furlanetto, Marcin Kubala and Felix Mulder + +$(document).ready(function() { + + var oldWidth = $("div#subpackage-spacer").width() + 1 + "px"; + $("div#packages > ul > li.current").on("click", function() { + $("div#subpackage-spacer").css({ "width": oldWidth }); + $("li.current-entities").toggle(); + }); + + var controls = { + visibility: { + publicFilter: $("#visbl").find("> ol > li.public"), + protectedFilter: $("#visbl").find("> ol > li.protected"), + privateFilter: $("#visbl").find("> ol > li.private") + } + }; + + // Escapes special characters and returns a valid jQuery selector + function escapeJquery(str){ + return str.replace(/([;&,\.\+\*\~':"\!\^#$%@\[\]\(\)=<>\|])/g, '\\$1'); + } + + function toggleVisibilityFilter() { + $(this).toggleClass("in").toggleClass("out"); + filter(); + } + + controls.visibility.publicFilter.on("click", toggleVisibilityFilter); + controls.visibility.protectedFilter.on("click", toggleVisibilityFilter); + controls.visibility.privateFilter.on("click", toggleVisibilityFilter); + + function exposeMember(jqElem) { + var jqElemParent = jqElem.parent(), + parentName = jqElemParent.attr("name"), + ancestorName = /^([^#]*)(#.*)?$/gi.exec(parentName)[1]; + + // switch visibility filter if necessary + if (jqElemParent.attr("visbl") == "prt") { + controls.visibility.privateFilter.removeClass("out").addClass("in"); + } + + // toggle appropriate ancestor filter buttons + if (ancestorName) { + $("#filterby li.out[name='" + ancestorName + "']").removeClass("out").addClass("in"); + } + + filter(); + jqElemParent.addClass("selected"); + commentToggleFct(jqElemParent); + $("#content-scroll-container").animate({scrollTop: $("#content-scroll-container").scrollTop() + jqElemParent.offset().top - $("#search").height() - 23 }, 1000); + } + + var isHiddenClass = function (name) { + return name == 'scala.Any' || + name == 'scala.AnyRef'; + }; + + var isHidden = function (elem) { + return $(elem).attr("data-hidden") == 'true'; + }; + + $("#linearization li").slice(1).filter(function(){ + return isHiddenClass($(this).attr("name")); + }).removeClass("in").addClass("out"); + + $("#implicits li").filter(function(){ + return isHidden(this); + }).removeClass("in").addClass("out"); + + $("#memberfilter > i.arrow").on("click", function() { + $(this).toggleClass("rotate"); + $("#filterby").toggle(); + }); + + // Pre-filter members + filter(); + + // Member filter box + var input = $("#memberfilter input"); + input.on("keyup", function(event) { + + switch ( event.keyCode ) { + + case 27: // escape key + input.val(""); + filter(true); + break; + + case 38: // up + input.val(""); + filter(false); + window.scrollTo(0, $("body").offset().top); + input.trigger("focus"); + break; + + case 33: //page up + input.val(""); + filter(false); + break; + + case 34: //page down + input.val(""); + filter(false); + break; + + default: + window.scrollTo(0, $("#mbrsel").offset().top - 130); + filter(true); + break; + + } + }); + input.on("focus", function(event) { + input.trigger("select"); + }); + $("#memberfilter > .clear").on("click", function() { + $("#memberfilter input").val(""); + $(this).hide(); + filter(); + }); + $(document).on("keydown", function(event) { + if (event.keyCode == 9) { // tab + $("#index-input", window.parent.document).trigger("focus"); + input.val( ""); + return false; + } + }); + + $("#linearization li").on("click", function(){ + if ($(this).hasClass("in")) { + $(this).removeClass("in"); + $(this).addClass("out"); + } else if ($(this).hasClass("out")) { + $(this).removeClass("out"); + $(this).addClass("in"); + } + filter(); + }); + + $("#implicits li").on("click", function(){ + if ($(this).hasClass("in")) { + $(this).removeClass("in"); + $(this).addClass("out"); + } else if ($(this).hasClass("out")) { + $(this).removeClass("out"); + $(this).addClass("in"); + } + filter(); + }); + + $("#mbrsel > div > div.ancestors > ol > li.hideall").on("click", function() { + $("#linearization li.in").removeClass("in").addClass("out"); + $("#linearization li:first").removeClass("out").addClass("in"); + $("#implicits li.in").removeClass("in").addClass("out"); + + if ($(this).hasClass("out") && $("#mbrsel > div > div.ancestors > ol > li.showall").hasClass("in")) { + $(this).removeClass("out").addClass("in"); + $("#mbrsel > div > div.ancestors > ol > li.showall").removeClass("in").addClass("out"); + } + + filter(); + }) + $("#mbrsel > div > div.ancestors > ol > li.showall").on("click", function() { + var filteredLinearization = + $("#linearization li.out").filter(function() { + return ! isHiddenClass($(this).attr("name")); + }); + filteredLinearization.removeClass("out").addClass("in"); + + var filteredImplicits = + $("#implicits li.out").filter(function() { + return ! isHidden(this); + }); + filteredImplicits.removeClass("out").addClass("in"); + + if ($(this).hasClass("out") && $("#mbrsel > div > div.ancestors > ol > li.hideall").hasClass("in")) { + $(this).removeClass("out").addClass("in"); + $("#mbrsel > div > div.ancestors > ol > li.hideall").removeClass("in").addClass("out"); + } + + filter(); + }); + $("#order > ol > li.alpha").on("click", function() { + if ($(this).hasClass("out")) + orderAlpha(); + }) + $("#order > ol > li.inherit").on("click", function() { + if ($(this).hasClass("out")) + orderInherit(); + }); + $("#order > ol > li.group").on("click", function() { + if ($(this).hasClass("out")) + orderGroup(); + }); + $("#groupedMembers").hide(); + + initInherit(); + + // Create tooltips + $(".extype").add(".defval").each(function(_,e) { + var $this = $(e); + $this.attr("title", $this.attr("name")); + }); + + /* Add toggle arrows */ + $("#template li[fullComment=yes] .modifier_kind").addClass("closed"); + + function commentToggleFct(element){ + $("#template li.selected").removeClass("selected"); + if (element.is("[fullcomment=no]")) { + return; + } + element.toggleClass("open"); + var signature = element.find(".modifier_kind") + var shortComment = element.find(".shortcomment"); + var fullComment = element.find(".fullcomment"); + var vis = $(":visible", fullComment); + signature.toggleClass("closed").toggleClass("opened"); + if (vis.length > 0) { + if (!isMobile()) { + shortComment.slideDown(100); + fullComment.slideUp(100); + } else { + fullComment.hide(); + shortComment.show(); + } + } + else { + if (!isMobile()) { + shortComment.slideUp(100); + fullComment.slideDown(100); + } else { + shortComment.hide(); + fullComment.show(); + } + } + }; + + $("#template li[fullComment=yes]").on("click", function() { + var sel = window.getSelection().toString(); + if (!sel) commentToggleFct($(this)); + }); + + /* Linear super types and known subclasses */ + function toggleShowContentFct(e){ + e.toggleClass("open"); + var content = $(".hiddenContent", e); + if(content.is(':visible')) { + if (!isMobile()) content.slideUp(100); + else content.hide(); + } else { + // TODO: is there a cleaner way to render the svg only once it's visible? + setTimeout(function() {content.trigger('beforeShow');}, 100); + if (!isMobile()) content.slideDown(100); + else content.show(); + } + }; + + $(".toggle").on("click", function() { + toggleShowContentFct($(this).parent()); + // Stop propagation so that we don't hide/show the parent (this a use case's full sig, which is nested in a member list) + if ($(this).parent().hasClass("full-signature-block")) return false; + }); + + if ($("#order > ol > li.group").length == 1) { orderGroup(); }; + + function findElementByHash(locationHash) { + var temp = locationHash.replace('#', ''); + var memberSelector = '#' + escapeJquery(temp); + return $(memberSelector); + } + + // highlight and jump to selected member if an anchor is provided + if (window.location.hash) { + var jqElem = findElementByHash(decodeURIComponent(window.location.hash)); + if (jqElem.length > 0) { + if (jqElem.hasClass("toggleContainer")) toggleShowContentFct(jqElem); + else exposeMember(jqElem); + } + } + + $("#template span.permalink").on("click", function(e) { + e.preventDefault(); + var href = $("a", this).attr("href"); + if (href.indexOf("#") != -1) { + var hash = href.split("#").pop() + try { + window.history.pushState({}, "", "#" + hash) + } catch (e) { + // fallback for file:// URLs, has worse scrolling behavior + location.hash = hash; + } + exposeMember(findElementByHash(hash)) + } + return false; + }); + + $("#mbrsel-input").on("input", function() { + if ($(this).val().length > 0) + $("#memberfilter > .clear").show(); + else + $("#memberfilter > .clear").hide(); + }); +}); + +function orderAlpha() { + $("#order > ol > li.alpha").removeClass("out").addClass("in"); + $("#order > ol > li.inherit").removeClass("in").addClass("out"); + $("#order > ol > li.group").removeClass("in").addClass("out"); + $("#template > div.parent").hide(); + $("#template > div.conversion").hide(); + $("#mbrsel > div.ancestors").show(); + filter(); +}; + +function orderInherit() { + $("#order > ol > li.inherit").removeClass("out").addClass("in"); + $("#order > ol > li.alpha").removeClass("in").addClass("out"); + $("#order > ol > li.group").removeClass("in").addClass("out"); + $("#template > div.parent").show(); + $("#template > div.conversion").show(); + $("#mbrsel > div.ancestors").hide(); + filter(); +}; + +function orderGroup() { + $("#order > ol > li.group").removeClass("out").addClass("in"); + $("#order > ol > li.alpha").removeClass("in").addClass("out"); + $("#order > ol > li.inherit").removeClass("in").addClass("out"); + $("#template > div.parent").hide(); + $("#template > div.conversion").hide(); + $("#mbrsel > div.ancestors").show(); + filter(); +}; + +/** Prepares the DOM for inheritance-based display. To do so it will: + * - hide all statically-generated parents headings; + * - copy all members from the value and type members lists (flat members) to corresponding lists nested below the + * parent headings (inheritance-grouped members); + * - initialises a control variable used by the filter method to control whether filtering happens on flat members + * or on inheritance-grouped members. */ +function initInherit() { + // inheritParents is a map from fully-qualified names to the DOM node of parent headings. + var inheritParents = new Object(); + var groupParents = new Object(); + $("#inheritedMembers > div.parent").each(function(){ + inheritParents[$(this).attr("name")] = $(this); + }); + $("#inheritedMembers > div.conversion").each(function(){ + inheritParents[$(this).attr("name")] = $(this); + }); + $("#groupedMembers > div.group").each(function(){ + groupParents[$(this).attr("name")] = $(this); + }); + + $("#types > ol > li").add("#deprecatedTypes > ol > li").each(function(){ + var mbr = $(this); + this.mbrText = mbr.find("> .fullcomment .cmt").text(); + var qualName = mbr.attr("name"); + var owner = qualName.slice(0, qualName.indexOf("#")); + var name = qualName.slice(qualName.indexOf("#") + 1); + var inheritParent = inheritParents[owner]; + if (inheritParent != undefined) { + var types = $("> .types > ol", inheritParent); + if (types.length == 0) { + inheritParent.append("

Type Members

    "); + types = $("> .types > ol", inheritParent); + } + var clone = mbr.clone(); + clone[0].mbrText = this.mbrText; + types.append(clone); + } + var group = mbr.attr("group") + var groupParent = groupParents[group]; + if (groupParent != undefined) { + var types = $("> .types > ol", groupParent); + if (types.length == 0) { + groupParent.append("
      "); + types = $("> .types > ol", groupParent); + } + var clone = mbr.clone(); + clone[0].mbrText = this.mbrText; + types.append(clone); + } + }); + + $(".values > ol > li").each(function(){ + var mbr = $(this); + this.mbrText = mbr.find("> .fullcomment .cmt").text(); + var qualName = mbr.attr("name"); + var owner = qualName.slice(0, qualName.indexOf("#")); + var name = qualName.slice(qualName.indexOf("#") + 1); + var inheritParent = inheritParents[owner]; + if (inheritParent != undefined) { + var values = $("> .values > ol", inheritParent); + if (values.length == 0) { + inheritParent.append("

      Value Members

        "); + values = $("> .values > ol", inheritParent); + } + var clone = mbr.clone(); + clone[0].mbrText = this.mbrText; + values.append(clone); + } + var group = mbr.attr("group") + var groupParent = groupParents[group]; + if (groupParent != undefined) { + var values = $("> .values > ol", groupParent); + if (values.length == 0) { + groupParent.append("
          "); + values = $("> .values > ol", groupParent); + } + var clone = mbr.clone(); + clone[0].mbrText = this.mbrText; + values.append(clone); + } + }); + $("#inheritedMembers > div.parent").each(function() { + if ($("> div.members", this).length == 0) { $(this).remove(); }; + }); + $("#inheritedMembers > div.conversion").each(function() { + if ($("> div.members", this).length == 0) { $(this).remove(); }; + }); + $("#groupedMembers > div.group").each(function() { + if ($("> div.members", this).length == 0) { $(this).remove(); }; + }); +}; + +/* filter used to take boolean scrollToMember */ +function filter() { + var query = $.trim($("#memberfilter input").val()).toLowerCase(); + query = query.replace(/[-[\]{}()*+?.,\\^$|#]/g, "\\$&").replace(/\s+/g, "|"); + var queryRegExp = new RegExp(query, "i"); + + var publicMembersShown = $("#visbl > ol > li.public").hasClass("in"); + var protectedMembersShown = $("#visbl > ol > li.protected").hasClass("in"); + var privateMembersShown = $("#visbl > ol > li.private").hasClass("in"); + + var orderingAlphabetic = $("#order > ol > li.alpha").hasClass("in"); + var orderingInheritance = $("#order > ol > li.inherit").hasClass("in"); + var orderingGroups = $("#order > ol > li.group").hasClass("in"); + var hiddenSuperclassElementsLinearization = orderingInheritance ? $("#linearization > li").slice(1) : $("#linearization > li.out"); + var hiddenSuperclassesLinearization = hiddenSuperclassElementsLinearization.map(function() { + return $(this).attr("name"); + }).get(); + var hiddenSuperclassElementsImplicits = orderingInheritance ? $("#implicits > li") : $("#implicits > li.out"); + var hiddenSuperclassesImplicits = hiddenSuperclassElementsImplicits.map(function() { + return $(this).attr("name"); + }).get(); + + var hideInheritedMembers; + + if (orderingAlphabetic) { + $("#allMembers").show(); + $("#inheritedMembers").hide(); + $("#groupedMembers").hide(); + hideInheritedMembers = true; + $("#allMembers > .members").each(filterFunc); + } else if (orderingGroups) { + $("#groupedMembers").show(); + $("#inheritedMembers").hide(); + $("#allMembers").hide(); + hideInheritedMembers = true; + $("#groupedMembers > .group > .members").each(filterFunc); + $("#groupedMembers > div.group").each(function() { + $(this).show(); + if ($("> div.members", this).not(":hidden").length == 0) { + $(this).hide(); + } else { + $(this).show(); + } + }); + } else if (orderingInheritance) { + $("#inheritedMembers").show(); + $("#groupedMembers").hide(); + $("#allMembers").hide(); + hideInheritedMembers = false; + $("#inheritedMembers > .parent > .members").each(filterFunc); + $("#inheritedMembers > .conversion > .members").each(filterFunc); + } + + + function filterFunc() { + var membersVisible = false; + var members = $(this); + members.find("> ol > li").each(function() { + var mbr = $(this); + var visibility = mbr.attr("visbl"); + if (!publicMembersShown && visibility == "pub") { + mbr.hide(); + return; + } + if (!protectedMembersShown && visibility == "prt") { + mbr.hide(); + return; + } + if (!privateMembersShown && visibility == "prv") { + mbr.hide(); + return; + } + var name = mbr.attr("name"); + // Owner filtering must not happen in "inherited from" member lists + if (hideInheritedMembers) { + var ownerIndex = name.indexOf("#"); + if (ownerIndex < 0) { + ownerIndex = name.lastIndexOf("."); + } + var owner = name.slice(0, ownerIndex); + for (var i = 0; i < hiddenSuperclassesLinearization.length; i++) { + if (hiddenSuperclassesLinearization[i] == owner) { + mbr.hide(); + return; + } + }; + for (var i = 0; i < hiddenSuperclassesImplicits.length; i++) { + if (hiddenSuperclassesImplicits[i] == owner) { + mbr.hide(); + return; + } + }; + } + if (query && !(queryRegExp.test(name) || queryRegExp.test(this.mbrText))) { + mbr.hide(); + return; + } + mbr.show(); + membersVisible = true; + }); + + if (membersVisible) + members.show(); + else + members.hide(); + }; + + return false; +}; + +/** Check if user agent is associated with a known mobile browser */ +function isMobile() { + return /Android|webOS|Mobi|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent); +} diff --git a/api/lib/trait.svg b/api/lib/trait.svg new file mode 100644 index 00000000..207a89f3 --- /dev/null +++ b/api/lib/trait.svg @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + t + + + + + + + diff --git a/api/lib/trait_comp.svg b/api/lib/trait_comp.svg new file mode 100644 index 00000000..8c83dec1 --- /dev/null +++ b/api/lib/trait_comp.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + t + + + + + + + + diff --git a/api/lib/trait_diagram.png b/api/lib/trait_diagram.png new file mode 100644 index 00000000..88983254 Binary files /dev/null and b/api/lib/trait_diagram.png differ diff --git a/api/lib/type_diagram.png b/api/lib/type_diagram.png new file mode 100644 index 00000000..d8152529 Binary files /dev/null and b/api/lib/type_diagram.png differ diff --git a/api/zio/index.html b/api/zio/index.html new file mode 100644 index 00000000..a8592d61 --- /dev/null +++ b/api/zio/index.html @@ -0,0 +1,2 @@ +

          Packages

          p

          zio

          package zio

          Linear Supertypes
          DurationModule, VersionSpecific, IntersectionTypeCompat, EitherCompat, BuildFromCompat, AnyRef, Any
          Ordering
          1. Alphabetic
          2. By Inheritance
          Inherited
          1. zio
          2. DurationModule
          3. VersionSpecific
          4. IntersectionTypeCompat
          5. EitherCompat
          6. BuildFromCompat
          7. AnyRef
          8. Any
          1. Hide All
          2. Show All
          Visibility
          1. Public
          2. Protected

          Package Members

          1. package prelude

          Type Members

          1. type &[+A, +B] = A with B
            Definition Classes
            IntersectionTypeCompat
          2. type BuildFrom[-From, -A, +C] = scala.collection.BuildFrom[From, A, C]
            Definition Classes
            BuildFromCompat
          3. type Duration = java.time.Duration
            Definition Classes
            DurationModule
          4. type EnvironmentTag[A] = izumi.reflect.Tag[A]
            Definition Classes
            VersionSpecific
          5. type IO[+E, +A] = ZIO[Any, E, A]
          6. type Layer[+E, +ROut] = ZLayer[Any, E, ROut]
          7. type LightTypeTag = izumi.reflect.macrortti.LightTypeTag
            Definition Classes
            VersionSpecific
          8. type RIO[-R, +A] = ZIO[R, Throwable, A]
          9. type RLayer[-RIn, +ROut] = ZLayer[RIn, Throwable, ROut]
          10. type RuntimeFlags = Int
          11. type TagK[F[_]] = HKTag[AnyRef { type Arg[A] = F[A] }]
            Definition Classes
            VersionSpecific
          12. type TagK10[F[_, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9] }]
            Definition Classes
            VersionSpecific
          13. type TagK11[F[_, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10] }]
            Definition Classes
            VersionSpecific
          14. type TagK12[F[_, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11] }]
            Definition Classes
            VersionSpecific
          15. type TagK13[F[_, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12] }]
            Definition Classes
            VersionSpecific
          16. type TagK14[F[_, _, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12,A13] }]
            Definition Classes
            VersionSpecific
          17. type TagK15[F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12,A13,A14] }]
            Definition Classes
            VersionSpecific
          18. type TagK16[F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12,A13,A14,A15] }]
            Definition Classes
            VersionSpecific
          19. type TagK17[F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12,A13,A14,A15,A16] }]
            Definition Classes
            VersionSpecific
          20. type TagK18[F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12,A13,A14,A15,A16,A17] }]
            Definition Classes
            VersionSpecific
          21. type TagK19[F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12,A13,A14,A15,A16,A17,A18] }]
            Definition Classes
            VersionSpecific
          22. type TagK20[F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12,A13,A14,A15,A16,A17,A18,A19] }]
            Definition Classes
            VersionSpecific
          23. type TagK21[F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12,A13,A14,A15,A16,A17,A18,A19,A20] }]
            Definition Classes
            VersionSpecific
          24. type TagK22[F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12,A13,A14,A15,A16,A17,A18,A19,A20,A21] }]
            Definition Classes
            VersionSpecific
          25. type TagK3[F[_, _, _]] = HKTag[AnyRef { type Arg[A, B, C] = F[A,B,C] }]
            Definition Classes
            VersionSpecific
          26. type TagK4[F[_, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3] = F[A0,A1,A2,A3] }]
            Definition Classes
            VersionSpecific
          27. type TagK5[F[_, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4] = F[A0,A1,A2,A3,A4] }]
            Definition Classes
            VersionSpecific
          28. type TagK6[F[_, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5] = F[A0,A1,A2,A3,A4,A5] }]
            Definition Classes
            VersionSpecific
          29. type TagK7[F[_, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6] = F[A0,A1,A2,A3,A4,A5,A6] }]
            Definition Classes
            VersionSpecific
          30. type TagK8[F[_, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7] = F[A0,A1,A2,A3,A4,A5,A6,A7] }]
            Definition Classes
            VersionSpecific
          31. type TagK9[F[_, _, _, _, _, _, _, _, _]] = HKTag[AnyRef { type Arg[A0, A1, A2, A3, A4, A5, A6, A7, A8] = F[A0,A1,A2,A3,A4,A5,A6,A7,A8] }]
            Definition Classes
            VersionSpecific
          32. type TagKK[F[_, _]] = HKTag[AnyRef { type Arg[A, B] = F[A,B] }]
            Definition Classes
            VersionSpecific
          33. type Task[+A] = ZIO[Any, Throwable, A]
          34. type TaskLayer[+ROut] = ZLayer[Any, Throwable, ROut]
          35. type Trace = Type with Traced
          36. type UIO[+A] = ZIO[Any, Nothing, A]
          37. type ULayer[+ROut] = ZLayer[Any, Nothing, ROut]
          38. type URIO[-R, +A] = ZIO[R, Nothing, A]
          39. type URLayer[-RIn, +ROut] = ZLayer[RIn, Nothing, ROut]
          40. abstract type ZAny >: Any
          41. abstract type ZNothing <: Nothing

          Value Members

          1. lazy val EnvironmentTag: izumi.reflect.Tag.type
            Definition Classes
            VersionSpecific
          2. lazy val TagK: izumi.reflect.TagK.type
            Definition Classes
            VersionSpecific
          3. lazy val TagK3: izumi.reflect.TagK3.type
            Definition Classes
            VersionSpecific
          4. lazy val TagKK: izumi.reflect.TagKK.type
            Definition Classes
            VersionSpecific
          5. implicit def buildFromNothing[Collection[+Element] <: Iterable[Element] with IterableOps[Any, Collection, _]]: BuildFrom[Collection[Any], Nothing, Collection[Nothing]]
            Definition Classes
            BuildFromCompat
          6. implicit def duration2DurationOps(duration: Duration): DurationOps
            Definition Classes
            DurationModule
          7. implicit def durationInt(n: Int): DurationSyntax
            Definition Classes
            DurationModule
          8. implicit def durationLong(n: Long): DurationSyntax
            Definition Classes
            DurationModule
          9. implicit val durationOrdering: Ordering[Duration]
            Definition Classes
            DurationModule

          Inherited from DurationModule

          Inherited from VersionSpecific

          Inherited from IntersectionTypeCompat

          Inherited from EitherCompat

          Inherited from BuildFromCompat

          Inherited from AnyRef

          Inherited from Any

          Ungrouped

          diff --git a/api/zio/prelude/index.html b/api/zio/prelude/index.html new file mode 100644 index 00000000..408571ad --- /dev/null +++ b/api/zio/prelude/index.html @@ -0,0 +1,2 @@ +

          Packages

          p

          zio

          prelude

          package prelude

          Linear Supertypes
          ZivariantSyntax, ZSetSyntax, ZNonEmptySetSyntax, PartialOrdSyntax, OrdSyntax, NonEmptySetSyntax, NonEmptyListSyntax, NonEmptyForEachSyntax, NewtypeFExports, InverseSyntax, InvariantSyntax, IdentitySyntax, IdentityEitherSyntax, IdentityBothSyntax, IdExports, HashSyntax, ForEachSyntax, EqualSyntax, DivariantSyntax, DebugSyntax, CovariantSyntax, ContravariantSyntax, ConstExports, CommutativeEitherSyntax, CommutativeBothSyntax, BicovariantSyntax, AssociativeFlattenSyntax, AssociativeEitherSyntax, AssociativeComposeSyntax, AssociativeBothSyntax, AssociativeSyntax, AnyRef, Any
          Ordering
          1. Alphabetic
          2. By Inheritance
          Inherited
          1. prelude
          2. ZivariantSyntax
          3. ZSetSyntax
          4. ZNonEmptySetSyntax
          5. PartialOrdSyntax
          6. OrdSyntax
          7. NonEmptySetSyntax
          8. NonEmptyListSyntax
          9. NonEmptyForEachSyntax
          10. NewtypeFExports
          11. InverseSyntax
          12. InvariantSyntax
          13. IdentitySyntax
          14. IdentityEitherSyntax
          15. IdentityBothSyntax
          16. IdExports
          17. HashSyntax
          18. ForEachSyntax
          19. EqualSyntax
          20. DivariantSyntax
          21. DebugSyntax
          22. CovariantSyntax
          23. ContravariantSyntax
          24. ConstExports
          25. CommutativeEitherSyntax
          26. CommutativeBothSyntax
          27. BicovariantSyntax
          28. AssociativeFlattenSyntax
          29. AssociativeEitherSyntax
          30. AssociativeComposeSyntax
          31. AssociativeBothSyntax
          32. AssociativeSyntax
          33. AnyRef
          34. Any
          1. Hide All
          2. Show All
          Visibility
          1. Public
          2. Protected

          Type Members

          1. type <=>[A, B] = Equivalence[A, B]
          2. type AnyF[_] = Any
          3. implicit class AssociativeBothContravariantOps[F[-_], A] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          4. implicit class AssociativeBothCovariantOps[F[+_], A] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          5. implicit class AssociativeBothOps[F[_], A] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          6. implicit class AssociativeBothTuple10Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          7. implicit class AssociativeBothTuple11Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          8. implicit class AssociativeBothTuple12Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          9. implicit class AssociativeBothTuple13Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          10. implicit class AssociativeBothTuple14Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          11. implicit class AssociativeBothTuple15Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          12. implicit class AssociativeBothTuple16Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          13. implicit class AssociativeBothTuple17Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          14. implicit class AssociativeBothTuple18Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          15. implicit class AssociativeBothTuple19Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          16. implicit class AssociativeBothTuple20Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          17. implicit class AssociativeBothTuple21Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          18. implicit class AssociativeBothTuple22Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          19. implicit class AssociativeBothTuple2Ops[F[+_], T1, T2] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          20. implicit class AssociativeBothTuple3Ops[F[+_], T1, T2, T3] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          21. implicit class AssociativeBothTuple4Ops[F[+_], T1, T2, T3, T4] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          22. implicit class AssociativeBothTuple5Ops[F[+_], T1, T2, T3, T4, T5] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          23. implicit class AssociativeBothTuple6Ops[F[+_], T1, T2, T3, T4, T5, T6] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          24. implicit class AssociativeBothTuple7Ops[F[+_], T1, T2, T3, T4, T5, T6, T7] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          25. implicit class AssociativeBothTuple8Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          26. implicit class AssociativeBothTuple9Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9] extends AnyRef
            Definition Classes
            AssociativeBothSyntax
          27. implicit class AssociativeComposeOps[A, B, =>:[-_, +_]] extends AnyRef
            Definition Classes
            AssociativeComposeSyntax
          28. implicit class AssociativeEitherContravariantOps[F[-_], A] extends AnyRef
            Definition Classes
            AssociativeEitherSyntax
          29. implicit class AssociativeEitherCovariantOps[F[+_], A] extends AnyRef
            Definition Classes
            AssociativeEitherSyntax
          30. implicit class AssociativeEitherOps[F[_], A] extends AnyRef
            Definition Classes
            AssociativeEitherSyntax
          31. implicit class AssociativeFlattenCovariantIdentityBothIdentityEitherOps[F[+_], A] extends AnyRef
            Definition Classes
            AssociativeFlattenSyntax
          32. implicit class AssociativeFlattenCovariantOps[F[+_], A] extends AnyRef
            Definition Classes
            AssociativeFlattenSyntax
          33. implicit class AssociativeFlattenOps[F[+_], A] extends AnyRef
            Definition Classes
            AssociativeFlattenSyntax
          34. implicit class AssociativeOps[+A] extends AnyRef
            Definition Classes
            AssociativeSyntax
          35. implicit class BicovariantOps[<=>[+_, +_], A, B] extends AnyRef
            Definition Classes
            BicovariantSyntax
          36. implicit class CommutativeBothContraVariantOps[F[-_], A] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          37. implicit class CommutativeBothCovariantOps[F[+_], A] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          38. implicit class CommutativeBothOps[F[_], A] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          39. implicit class CommutativeBothTuple10Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          40. implicit class CommutativeBothTuple11Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          41. implicit class CommutativeBothTuple12Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          42. implicit class CommutativeBothTuple13Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          43. implicit class CommutativeBothTuple14Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          44. implicit class CommutativeBothTuple15Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          45. implicit class CommutativeBothTuple16Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          46. implicit class CommutativeBothTuple17Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          47. implicit class CommutativeBothTuple18Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          48. implicit class CommutativeBothTuple19Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          49. implicit class CommutativeBothTuple20Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          50. implicit class CommutativeBothTuple21Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          51. implicit class CommutativeBothTuple22Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          52. implicit class CommutativeBothTuple2Ops[F[+_], T1, T2] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          53. implicit class CommutativeBothTuple3Ops[F[+_], T1, T2, T3] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          54. implicit class CommutativeBothTuple4Ops[F[+_], T1, T2, T3, T4] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          55. implicit class CommutativeBothTuple5Ops[F[+_], T1, T2, T3, T4, T5] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          56. implicit class CommutativeBothTuple6Ops[F[+_], T1, T2, T3, T4, T5, T6] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          57. implicit class CommutativeBothTuple7Ops[F[+_], T1, T2, T3, T4, T5, T6, T7] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          58. implicit class CommutativeBothTuple8Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          59. implicit class CommutativeBothTuple9Ops[F[+_], T1, T2, T3, T4, T5, T6, T7, T8, T9] extends AnyRef
            Definition Classes
            CommutativeBothSyntax
          60. implicit class CommutativeEitherContravariantOps[F[-_], A] extends AnyRef
            Definition Classes
            CommutativeEitherSyntax
          61. implicit class CommutativeEitherCovariantOps[F[+_], A] extends AnyRef
            Definition Classes
            CommutativeEitherSyntax
          62. implicit class CommutativeEitherOps[F[_], A] extends AnyRef
            Definition Classes
            CommutativeEitherSyntax
          63. type Const[+A, +B] = Type[A]
            Definition Classes
            ConstExports
          64. implicit class ContravariantOps[F[-_], A] extends AnyRef
            Definition Classes
            ContravariantSyntax
          65. implicit class CovariantOps[F[+_], A] extends AnyRef
            Definition Classes
            CovariantSyntax
          66. implicit final class DebugInterpolator extends AnyRef
            Definition Classes
            DebugSyntax
          67. implicit class DebugOps[A] extends AnyRef
            Definition Classes
            DebugSyntax
          68. type DeriveAssociative[F[_]] = Derive[F, Associative]
          69. type DeriveCommutative[F[_]] = Derive[F, Commutative]
          70. type DeriveDebug[F[_]] = Derive[F, Debug]
          71. type DeriveEqual[F[_]] = Derive[F, Equal]
          72. type DeriveHash[F[_]] = Derive[F, Hash]
          73. type DeriveIdentity[F[_]] = Derive[F, Identity]
          74. type DeriveInverse[F[_]] = Derive[F, Inverse]
          75. type DeriveOrd[F[_]] = Derive[F, Ord]
          76. implicit class DivariantOps[=>:[-_, +_], A, B] extends AnyRef
            Definition Classes
            DivariantSyntax
          77. type EReader[-R, +E, +A] = ZPure[Nothing, Unit, Unit, R, E, A]
          78. type EState[S, +E, +A] = ZPure[Nothing, S, S, Any, E, A]
          79. type EWriter[+W, +E, +A] = ZPure[W, Unit, Unit, Any, E, A]
          80. implicit class EqualOps[A] extends AnyRef
            Definition Classes
            EqualSyntax
          81. implicit class Flip1Ops[F[+_], G[+_], A] extends AnyRef
            Definition Classes
            NonEmptyForEachSyntax
          82. implicit class FlipOps[F[+_], G[+_], A] extends AnyRef
            Definition Classes
            ForEachSyntax
          83. implicit class ForEachOps[F[+_], A] extends AnyRef
            Definition Classes
            ForEachSyntax
          84. implicit class HashOps[A] extends AnyRef
            Definition Classes
            HashSyntax
          85. type Id[+A] = Type[A]
            Definition Classes
            IdExports
          86. implicit class IdentityBothAnyOps[A] extends AnyRef
            Definition Classes
            IdentityBothSyntax
          87. implicit class IdentityEitherAnyOps extends AnyRef
            Definition Classes
            IdentityEitherSyntax
          88. implicit class IdentityOps[A] extends AnyRef
            Definition Classes
            IdentitySyntax
          89. implicit class InvariantOps[F[_], A] extends AnyRef
            Definition Classes
            InvariantSyntax
          90. implicit class InverseOps[A] extends AnyRef
            Definition Classes
            InverseSyntax
          91. type MultiSet[+A] = ZSet[A, Natural]
          92. abstract class NewtypeF extends prelude.NewtypeModuleF.NewtypeF
            Definition Classes
            NewtypeFExports
          93. implicit class NonEmptyForEachOps[F[+_], A] extends AnyRef
            Definition Classes
            NonEmptyForEachSyntax
          94. implicit final class NonEmptyListConsOps[A] extends AnyRef
            Definition Classes
            NonEmptyListSyntax
          95. implicit final class NonEmptyListListOps[A] extends AnyRef
            Definition Classes
            NonEmptyListSyntax
          96. type NonEmptyMultiSet[+A] = ZNonEmptySet[A, Natural]
          97. implicit final class NonEmptySetIterableOps[A] extends AnyRef
            Definition Classes
            NonEmptySetSyntax
          98. implicit final class NonEmptySetSetOps[A] extends AnyRef
            Definition Classes
            NonEmptySetSyntax
          99. implicit class OrdOps[A] extends AnyRef
            Definition Classes
            OrdSyntax
          100. implicit class PartialOrdOps[A] extends AnyRef
            Definition Classes
            PartialOrdSyntax
          101. type Reader[-R, +A] = ZPure[Nothing, Unit, Unit, R, Nothing, A]
          102. type State[S, +A] = ZPure[Nothing, S, S, Any, Nothing, A]
          103. abstract class SubtypeF extends prelude.NewtypeModuleF.SubtypeF
            Definition Classes
            NewtypeFExports
          104. type Validation[+E, +A] = ZValidation[Nothing, E, A]
          105. type Writer[+W, +A] = ZPure[W, Unit, Unit, Any, Nothing, A]
          106. implicit final class ZNonEmptySetMapOps[+A] extends AnyRef
            Definition Classes
            ZNonEmptySetSyntax
          107. implicit final class ZNonEmptySetNonEmptyMultiSetOps[+A] extends AnyRef
            Definition Classes
            ZNonEmptySetSyntax
          108. implicit final class ZSetMapOps[+A] extends AnyRef
            Definition Classes
            ZSetSyntax
          109. implicit final class ZSetMultiSetOps[+A] extends AnyRef
            Definition Classes
            ZSetSyntax
          110. implicit class ZivariantOps[Z[-_, +_, +_], R, E, A] extends AnyRef
            Definition Classes
            ZivariantSyntax

          Value Members

          1. val EReader: ZPure.type
          2. val EState: ZPure.type
          3. val EWriter: ZPure.type
          4. val MultiSet: ZSet.type
          5. val NonEmptyMultiSet: ZNonEmptySet.type
          6. val Reader: ZPure.type
          7. val State: ZPure.type
          8. val Validation: ZValidation.type
          9. val Writer: ZPure.type

          Inherited from ZivariantSyntax

          Inherited from ZSetSyntax

          Inherited from ZNonEmptySetSyntax

          Inherited from PartialOrdSyntax

          Inherited from OrdSyntax

          Inherited from NonEmptySetSyntax

          Inherited from NonEmptyListSyntax

          Inherited from NonEmptyForEachSyntax

          Inherited from NewtypeFExports

          Inherited from InverseSyntax

          Inherited from InvariantSyntax

          Inherited from IdentitySyntax

          Inherited from IdentityEitherSyntax

          Inherited from IdentityBothSyntax

          Inherited from IdExports

          Inherited from HashSyntax

          Inherited from ForEachSyntax

          Inherited from EqualSyntax

          Inherited from DivariantSyntax

          Inherited from DebugSyntax

          Inherited from CovariantSyntax

          Inherited from ContravariantSyntax

          Inherited from ConstExports

          Inherited from CommutativeEitherSyntax

          Inherited from CommutativeBothSyntax

          Inherited from BicovariantSyntax

          Inherited from AssociativeFlattenSyntax

          Inherited from AssociativeEitherSyntax

          Inherited from AssociativeComposeSyntax

          Inherited from AssociativeBothSyntax

          Inherited from AssociativeSyntax

          Inherited from AnyRef

          Inherited from Any

          Ungrouped

          diff --git a/build.sbt b/build.sbt deleted file mode 100644 index d959d889..00000000 --- a/build.sbt +++ /dev/null @@ -1,212 +0,0 @@ -val scala212 = "2.12.18" -val scala213 = "2.13.12" -val scala3 = "3.3.5" - -val zio2Version = "2.1.17" - -def scalacOptions212(jdk: Int) = Seq( - "-Ypartial-unification", - "-deprecation", - "-Xsource:3", - "-release", - jdk.toString -) -def scalacOptions213(jdk: Int) = - Seq("-deprecation", "-Xsource:3", "-release", jdk.toString) -def scalacOptions3(jdk: Int) = - Seq("-deprecation", "-Ykind-projector", "-release", jdk.toString) - -import microsites.ConfigYml -import xerial.sbt.Sonatype._ - -import scala.xml.{Node => XmlNode, NodeSeq => XmlNodeSeq, _} -import scala.xml.transform.{RewriteRule, RuleTransformer} - -ThisBuild / dynverSonatypeSnapshots := true - -def commonSettings(jdk: Int) = Seq( - organization := "io.github.vigoo", - scalaVersion := scala213, - crossScalaVersions := List(scala212, scala213, scala3), - libraryDependencies ++= - (CrossVersion.partialVersion(scalaVersion.value) match { - case Some((3, _)) => Seq.empty - case _ => - Seq( - compilerPlugin( - "org.typelevel" % "kind-projector" % "0.13.3" cross CrossVersion.full - ) - ) - }), - libraryDependencies ++= Seq( - "org.scala-lang.modules" %% "scala-collection-compat" % "2.13.0" - ), - Test / compile / coverageEnabled := true, - Compile / compile / coverageEnabled := false, - scalacOptions ++= (CrossVersion.partialVersion(scalaVersion.value) match { - case Some((2, 12)) => scalacOptions212(jdk) - case Some((2, 13)) => scalacOptions213(jdk) - case Some((3, _)) => scalacOptions3(jdk) - case _ => Nil - }), - - // Publishing - - publishMavenStyle := true, - licenses := Seq( - "APL2" -> url("http://www.apache.org/licenses/LICENSE-2.0.txt") - ), - sonatypeProjectHosting := Some( - GitHubHosting("vigoo", "prox", "daniel.vigovszky@gmail.com") - ), - developers := List( - Developer( - id = "vigoo", - name = "Daniel Vigovszky", - email = "daniel.vigovszky@gmail.com", - url = url("https://vigoo.github.io/") - ) - ), - sonatypeCredentialHost := "s01.oss.sonatype.org", - sonatypeRepository := "https://s01.oss.sonatype.org/service/local", - credentials ++= - (for { - username <- Option(System.getenv().get("SONATYPE_USERNAME")) - password <- Option(System.getenv().get("SONATYPE_PASSWORD")) - } yield Credentials( - "Sonatype Nexus Repository Manager", - "s01.oss.sonatype.org", - username, - password - )).toSeq -) - -lazy val prox = project - .in(file(".")) - .settings(commonSettings(8)) - .settings( - name := "prox", - organization := "io.github.vigoo", - publish / skip := true - ) - .aggregate(proxCore, proxFS23, proxZStream2, proxJava9) - -lazy val proxCore = - Project("prox-core", file("prox-core")).settings(commonSettings(8)) - -lazy val proxFS23 = Project("prox-fs2-3", file("prox-fs2-3")) - .settings(commonSettings(8)) - .settings( - libraryDependencies ++= Seq( - "co.fs2" %% "fs2-core" % "3.12.0", - "co.fs2" %% "fs2-io" % "3.12.0", - "dev.zio" %% "zio" % zio2Version % "test", - "dev.zio" %% "zio-test" % zio2Version % "test", - "dev.zio" %% "zio-test-sbt" % zio2Version % "test", - "dev.zio" %% "zio-interop-cats" % "23.1.0.3" % "test" - ), - testFrameworks += new TestFramework("zio.test.sbt.ZTestFramework") - ) - .dependsOn(proxCore) - -lazy val proxZStream2 = Project("prox-zstream-2", file("prox-zstream-2")) - .settings(commonSettings(8)) - .settings( - resolvers += - "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots", - libraryDependencies ++= Seq( - "dev.zio" %% "zio" % zio2Version, - "dev.zio" %% "zio-streams" % zio2Version, - "dev.zio" %% "zio-prelude" % "1.0.0-RC28", - "dev.zio" %% "zio-test" % zio2Version % "test", - "dev.zio" %% "zio-test-sbt" % zio2Version % "test" - ), - testFrameworks += new TestFramework("zio.test.sbt.ZTestFramework") - ) - .dependsOn(proxCore) - -lazy val proxJava9 = Project("prox-java9", file("prox-java9")) - .settings(commonSettings(9)) - .dependsOn(proxCore) - -lazy val docs = project - .enablePlugins( - GhpagesPlugin, - SiteScaladocPlugin, - ScalaUnidocPlugin, - MicrositesPlugin - ) - .settings(commonSettings(9)) - .settings( - addCompilerPlugin( - "org.typelevel" %% s"kind-projector" % "0.13.2" cross CrossVersion.full - ), - publishArtifact := false, - publish / skip := true, - scalaVersion := scala213, - name := "prox", - description := "A Scala library for working with system processes", - git.remoteRepo := "git@github.com:vigoo/prox.git", - ScalaUnidoc / siteSubdirName := "api", - addMappingsToSiteDir( - ScalaUnidoc / packageDoc / mappings, - ScalaUnidoc / siteSubdirName - ), - ScalaUnidoc / unidoc / unidocProjectFilter := inProjects( - proxCore, - proxFS23, - proxZStream2, - proxJava9 - ), - micrositeUrl := "https://vigoo.github.io/", - micrositeBaseUrl := "/prox", - micrositeHomepage := "https://vigoo.github.io/prox/", - micrositeDocumentationUrl := "/prox/docs", - micrositeAuthor := "Daniel Vigovszky", - micrositeTwitterCreator := "@dvigovszky", - micrositeGithubOwner := "vigoo", - micrositeGithubRepo := "prox", - micrositeGitterChannel := false, - micrositeDataDirectory := baseDirectory.value / "src/microsite/data", - micrositeStaticDirectory := baseDirectory.value / "src/microsite/static", - micrositeImgDirectory := baseDirectory.value / "src/microsite/img", - micrositeCssDirectory := baseDirectory.value / "src/microsite/styles", - micrositeSassDirectory := baseDirectory.value / "src/microsite/partials", - micrositeJsDirectory := baseDirectory.value / "src/microsite/scripts", - micrositeTheme := "light", - micrositeHighlightLanguages ++= Seq("scala", "sbt"), - micrositeConfigYaml := ConfigYml( - yamlCustomProperties = Map( - "url" -> "https://vigoo.github.io/", - "plugins" -> List("jemoji", "jekyll-sitemap") - ) - ), - micrositeAnalyticsToken := "UA-56320875-3", - micrositePushSiteWith := GitHub4s, - micrositeGithubToken := sys.env.get("GITHUB_TOKEN"), - makeSite / includeFilter := "*.html" | "*.css" | "*.png" | "*.jpg" | "*.gif" | "*.js" | "*.swf" | "*.txt" | "*.xml" | "*.svg", - // Temporary fix to avoid including mdoc in the published POM - - // skip dependency elements with a scope - pomPostProcess := { (node: XmlNode) => - new RuleTransformer(new RewriteRule { - override def transform(node: XmlNode): XmlNodeSeq = node match { - case e: Elem - if e.label == "dependency" && e.child.exists(child => - child.label == "artifactId" && child.text.startsWith("mdoc_") - ) => - val organization = - e.child.filter(_.label == "groupId").flatMap(_.text).mkString - val artifact = - e.child.filter(_.label == "artifactId").flatMap(_.text).mkString - val version = - e.child.filter(_.label == "version").flatMap(_.text).mkString - Comment( - s"dependency $organization#$artifact;$version has been omitted" - ) - case _ => node - } - }).transform(node).head - } - ) - .dependsOn(proxCore, proxFS23, proxZStream2, proxJava9) diff --git a/codecov.yml b/codecov.yml deleted file mode 100644 index b9bfa98b..00000000 --- a/codecov.yml +++ /dev/null @@ -1,6 +0,0 @@ -coverage: - precision: 0 - round: down - status: - default_rules: - threshold: 2% diff --git a/css/light-style.css b/css/light-style.css new file mode 100644 index 00000000..58046c71 --- /dev/null +++ b/css/light-style.css @@ -0,0 +1 @@ +@import url("https://fonts.googleapis.com/css?family=Fira+Mono:400,500,700&display=swap");@import url("https://fonts.googleapis.com/css?family=Open+Sans:400,600,700&display=swap");@import url("https://fonts.googleapis.com/css?family=Hind:400,500,600&display=swap");body{margin:0;font-size:15px;color:#333;background:#fff;font-family:"Open Sans",sans-serif}a{color:#009ADA;text-decoration:none}.container{max-width:980px;margin:0 auto;padding:0 24px}h1,h2,h3,h4,h5,h6{font-family:"Hind",sans-serif;position:relative}h1{font-size:2.2rem}h2{font-size:2rem}h3{font-size:1.6rem}h4{font-size:1.3rem}h5{font-size:1.2rem}h6{font-size:1.1rem}@keyframes bg-gradient{0%{background-position:50%}36%{background-position:60%}40%{background-position:80%}50%{background-position:40%}66%{background-position:15%}100%{background-position:50%}}#navigation{background:#fff;padding:16px 0;font-family:"Hind",sans-serif;height:64px;display:flex;flex:0 0 56px}#navigation a{color:#333}#navigation .navbar-wrapper{z-index:20;display:flex;align-items:center;justify-content:space-between;position:relative;width:100%}#navigation .navbar-wrapper .navigation-brand{font-size:18px}#navigation .navbar-wrapper .navigation-brand .brand{display:inline-flex;align-items:center}#navigation .navbar-wrapper .navigation-brand .brand:hover{background:none}#navigation .navbar-wrapper .navigation-brand .brand .icon-wrapper{width:36px;height:36px;margin-right:8px}@keyframes subtle-transition{80%{background-color:#013567}95%{background-color:#333}}#navigation .navbar-wrapper .navigation-brand .brand .brand-title{position:absolute;font-weight:500;white-space:nowrap;left:70px}#navigation .navbar-wrapper .navigation-brand .custom-feature-icon .icon-wrapper{background:url("http://github.com/img/light-navbar-brand.svg") no-repeat}#navigation .navbar-wrapper .navigation-brand .background-mask .icon-wrapper{-webkit-mask:url("http://github.com/img/light-navbar-brand.svg") no-repeat;mask:url("http://github.com/img/light-navbar-brand.svg") no-repeat;background-color:#013567;animation:subtle-transition 6.66s infinite linear}#navigation .navbar-wrapper .navigation-menu>ul>li:not(:first-child){margin-left:24px}#navigation .navbar-wrapper .navigation-menu li{display:inline-block;list-style:none}#navigation .navbar-wrapper .navigation-menu li a span:focus,#navigation .navbar-wrapper .navigation-menu li a span:hover{border-bottom:2px solid}#navigation .navbar-wrapper .navigation-menu li a i:focus,#navigation .navbar-wrapper .navigation-menu li a i:hover{opacity:0.7}#navigation .navbar-wrapper .navigation-menu .nav-item-text+.nav-item-text{margin-left:8px}@media (max-width: 868px){#navigation .navbar-wrapper .navigation-menu .nav-item-text{display:none}}#navigation .navbar-wrapper .navigation-menu .nav-item-icon{display:none}@media (max-width: 868px){#navigation .navbar-wrapper .navigation-menu .nav-item-icon{display:inline-block}}@media (max-width: 868px){#navigation .navbar-wrapper .navigation-menu .search-nav{display:none}}.button{display:block;background:none;border:none;outline:none;text-decoration:none;position:relative}.button:hover{cursor:pointer}.button>img{vertical-align:bottom}.button.link-like{font-size:15px;text-transform:none;color:#333;font-family:"Hind",sans-serif;padding:0}.button.link-like:hover,.button.link-like:focus{text-decoration:none;box-shadow:0 2px #333}.close{height:28px;position:absolute;left:0;top:0;width:32px}.close::after,.close::before{background-color:#fff;content:" ";height:100%;left:98%;position:absolute;top:34%;width:2px}.close::before{transform:rotate(45deg)}.close::after{transform:rotate(-45deg)}#masthead{background:linear-gradient(160deg, transparent 66%, #011e3a 97%),linear-gradient(130deg, #012549, #013567 16%);background-position:center;background-size:200% 100%;animation:bg-gradient 12s ease infinite;color:#fff;flex:1 0 auto;max-height:50%;padding:48px 0;font-family:"Hind",sans-serif;display:flex;flex-direction:row;align-items:center}#masthead .text-center{text-align:center;max-width:750px}#masthead .text-center .masthead-description{font-size:3rem;margin-bottom:56px;font-weight:600}#masthead .masthead-button{text-align:center;color:#fff;padding:11px 40px;border:2px solid #fff;font-weight:600;border-radius:2px;transition:all 350ms ease}#masthead .masthead-button:hover{background-color:#fff;color:#013567}.menu-container{border-bottom:solid 1px rgba(51,51,51,0.1)}#horizontal-menu{display:flex;justify-content:left;max-width:980px;margin:0 auto;padding:0 24px;min-height:44px}#horizontal-menu .horizontal-nav{display:inline-flex;flex-wrap:wrap;list-style:none;margin:0;padding:0}#horizontal-menu .horizontal-nav li{margin-right:32px;padding:10px 0}#horizontal-menu .horizontal-nav li a{padding:10px 0;font-weight:600;color:rgba(51,51,51,0.7);transition:color 0.4ms ease}#horizontal-menu .horizontal-nav li a.active{color:#013567}#horizontal-menu .horizontal-nav li a:hover{color:#333;border-bottom:solid 3px #333}.home{height:100%;display:flex;flex-direction:column}#site-main{background-color:rgba(1,53,103,0.05);font-family:"Open Sans",sans-serif;flex:1 0 auto;display:flex;flex-direction:column;justify-content:center}#site-main.page-site-main{flex:1 0 auto}#site-main .main-content{flex:1 0 auto;padding:48px 0}#site-main a{text-decoration:underline}#site-main a:hover{text-decoration:none}#content p{line-height:22px}#content ul{padding-left:16px}#content ul li{line-height:32px;padding-left:8px}#search-dropdown{position:relative}#search-dropdown .dropdown{display:block;outline:0;width:100%}#search-dropdown label{padding-right:0.3em;font-weight:normal}#search-dropdown label i{padding-right:0.2em}#search-dropdown .dropdown-content{position:absolute;min-width:100px;overflow:hidden auto;box-shadow:0 8px 16px 0 rgba(0,0,0,0.2);z-index:1;background:#fff;margin:0;padding:0;opacity:0.5;transform:rotate3d(1, 0, 0, 90deg);transition:transform ease 250ms, opacity ease 100ms;transform-origin:top}#search-dropdown .dropdown-content .dropdown-item{width:100%;text-align:left}#search-dropdown .dropdown-content .dropdown-item .dropdown-item-link{padding:12px 9px;text-decoration:none;display:block;border-radius:0;color:#333}#search-dropdown .dropdown-content .dropdown-item .dropdown-item-link:hover span{border-bottom:2px solid}#search-dropdown .dropdown-content .dropdown-item .dropdown-item-link:focus span{border-bottom:2px solid}#search-dropdown .show{transform:rotate3d(1, 0, 0, 0);opacity:1}div[id$='version-dropdown']{position:relative}div[id$='version-dropdown'] .dropdown{display:block;outline:0;width:100%}div[id$='version-dropdown'] .dropdown-content{position:absolute;min-width:100px;overflow:hidden auto;box-shadow:0 8px 16px 0 rgba(0,0,0,0.2);z-index:1;background:#fff;margin:0;padding:0;opacity:0.5;transform:rotate3d(1, 0, 0, 90deg);transition:transform ease 250ms, opacity ease 100ms;transform-origin:top}div[id$='version-dropdown'] .dropdown-content .dropdown-item{width:100%}div[id$='version-dropdown'] .dropdown-content .dropdown-item .dropdown-item-link{padding:12px 9px;text-decoration:none;display:block;border-radius:0}div[id$='version-dropdown'] .dropdown-content .dropdown-item .dropdown-item-link:hover span{border-bottom:2px solid}div[id$='version-dropdown'] .show{transform:rotate3d(1, 0, 0, 0);opacity:1}#site-footer{font-family:"Hind",sans-serif;padding:40px 0;font-size:14px}#site-footer .row{margin:0 auto}#site-footer .row p{margin:8px 0}#site-footer .row a{text-decoration:underline}#site-footer .row a:hover{text-decoration:none}@media (max-width: 868px){#site-footer{text-align:center}}.docs{background:rgba(1,53,103,0.05);height:100%;display:flex;flex-direction:column}.docs #wrapper{padding-left:290px;transition:padding-left 0.5s ease}.docs #wrapper.toggled{padding-left:0}.docs #wrapper.toggled #sidebar-wrapper{left:-290px}.docs #page-content-wrapper #content .content-wrapper a{text-decoration:underline}.docs #page-content-wrapper #content .content-wrapper a:hover{text-decoration:none}.docs #sidebar-wrapper{background-image:linear-gradient(to bottom, #013567 60%, #012549 100%);z-index:1000;position:fixed;left:0;height:100%;width:290px;overflow:hidden hidden;transition:left 0.5s ease}.docs #sidebar-wrapper:hover{overflow:hidden auto}.docs #sidebar-wrapper .sidebar-toggle{display:none}.docs #sidebar-wrapper #sidebar-brand{padding:12px 24px;font-family:"Hind",sans-serif;font-size:18px;height:64px;display:flex;justify-content:space-between;align-items:center;background-color:#013a71}.docs #sidebar-wrapper #sidebar-brand a{display:inline-flex;align-items:center;color:#fff}.docs #sidebar-wrapper #sidebar-brand a .brand-wrapper{position:relative;width:36px;height:36px;background:url("http://github.com/img/light-sidebar-brand.svg") no-repeat}.docs #sidebar-wrapper #sidebar-brand a span{z-index:30;white-space:nowrap;position:absolute;left:70px;font-weight:500}.docs #sidebar-wrapper .sidebar-nav{margin-top:16px;padding:0}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item{display:flex;flex-direction:column;position:relative}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item .sub-section{background:#013a71;max-height:0;transition:max-height 0.3s ease-in-out;overflow:hidden}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item .sub-section a{display:flex;justify-content:flex-start;align-items:center;padding:16px 32px;font-size:0.875rem;height:auto}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item .sub-section a.active{color:#fff;box-shadow:3px 0 #009ADA inset}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item a,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item button{box-sizing:border-box;font-family:"Open Sans", sans-serif;font-size:0.95rem;display:flex;justify-content:space-between;align-items:center;padding:16px 24px;line-height:16px;width:100%;transition:background 0.33s ease-in-out}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item a,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item button{color:#fff}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item a:visited,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item button:visited{color:#fff}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item a:hover,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item button:hover{color:rgba(255,255,255,0.8)}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item a:active,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item a:focus,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item button:active,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item button:focus{color:#fff}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item a:hover,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item button:hover{text-decoration:none}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item .fa{pointer-events:none;position:absolute;color:#fff;font-size:1.2rem;right:16px;top:16px;transition:transform 0.25s;line-height:16px}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.active>a,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.active button{box-shadow:3px 0 #009ADA inset}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open>a,.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open button{background:#013f7b}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open .fa{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open .sub-section{max-height:1600px}.docs #page-content-wrapper{width:100%}.docs #page-content-wrapper .nav{background:#fff}.docs #page-content-wrapper .nav .action-menu a{font-size:24px;padding:0 4px}.docs #page-content-wrapper .nav .action-menu a:hover{transform:scaleX(1.5)}.docs #page-content-wrapper .nav .col-lg-12{padding:12px 24px;display:flex;justify-content:space-between;align-items:center;height:64px}.docs #page-content-wrapper .nav a:not(.dropdown-item-link){color:#013567;padding:0 16px;display:block;font-size:16px;transition:color 0.25s ease, transform 0.25s ease}.docs #page-content-wrapper .nav a:not(.dropdown-item-link):hover{color:#013f7b}.docs #page-content-wrapper .nav ul{padding:0;margin:0}@media (max-width: 530px){.docs #page-content-wrapper .nav ul .search-nav{display:none !important}}.docs #page-content-wrapper .nav ul li{list-style:none;display:inline-block}.docs #page-content-wrapper .nav ul li span:not(.dropdown-item-link-text){display:inline-flex;flex-direction:row-reverse;font-size:14px}.docs #page-content-wrapper .nav ul li .label{margin:0 8px;font-weight:bold;color:#013567}.docs #page-content-wrapper section{background:#fff;margin:24px;border-radius:2px;padding:32px}.docs #page-content-wrapper section a:focus,.docs #page-content-wrapper section a:hover{text-decoration:none}.docs #page-content-wrapper section a:focus{outline:0}.docs #page-content-wrapper section code{padding:2px 4px;border-radius:2px}.docs #page-content-wrapper section pre{padding:0;font-size:13px;margin-top:20px}.docs #page-content-wrapper section pre code{font-family:"Fira Mono",monospace;font-size:inherit;white-space:pre-wrap;border-radius:2px;border:solid 1px rgba(1,1,1,0.2)}.docs #page-content-wrapper section pre .hljs{padding:24px}.docs #page-content-wrapper section .hljs-addition,.docs #page-content-wrapper section .hljs-meta,.docs #page-content-wrapper section .hljs-string,.docs #page-content-wrapper section .hljs-symbol,.docs #page-content-wrapper section .hljs-template-tag,.docs #page-content-wrapper section .hljs-template-variable{line-height:24px}.docs #page-content-wrapper .header-link{position:absolute;font-size:0.6em;left:-2em;top:-0.05em;opacity:0;padding:0.8em;transform:scale3d(0.5, 0.5, 0.5);transition:opacity 0.2s ease, transform 0.2s ease}.docs #page-content-wrapper .header-link .fa{transform:rotate3d(0, 0, 1, 135deg)}.docs #page-content-wrapper h1:hover .header-link,.docs #page-content-wrapper h2:hover .header-link,.docs #page-content-wrapper h3:hover .header-link,.docs #page-content-wrapper h4:hover .header-link,.docs #page-content-wrapper h5:hover .header-link,.docs #page-content-wrapper h6:hover .header-link{opacity:1;transform:scale3d(1, 1, 1)}.docs .sidebar-toggle{background:none;border:none;color:rgba(1,53,103,0.05);display:inline-block;padding:24px 32px;position:relative;text-align:center;text-decoration:none;transition:color 0.3s ease, transform 0.3s ease}.docs .sidebar-toggle .menu-icon{position:absolute;top:37%;left:38%}.docs .sidebar-toggle:hover{color:#fff;cursor:pointer}@media (max-width: 868px){.docs #wrapper{padding-left:0;transition:padding-left 0.4s ease}.docs #sidebar-wrapper{left:-100%}.docs #wrapper.toggled #sidebar-wrapper{left:0;width:100%;overflow-y:auto}.docs #wrapper.toggled #sidebar-wrapper .sidebar-toggle{display:block;opacity:0.7;transition:opacity 0.3s ease, transform 0.3s ease}.docs #wrapper.toggled #sidebar-wrapper .sidebar-toggle:hover{opacity:1;transform:rotate(-180deg)}.docs #wrapper.toggled #page-content-wrapper{height:100vh;overflow:hidden}}code[class="highlighter-rouge"]{background-color:rgba(1,53,103,0.1)}.page{height:100%;display:flex;flex-direction:column}.page #navigation{background:linear-gradient(160deg, transparent 66%, #011e3a 97%),linear-gradient(130deg, #012549, #013567 16%);background-position:center;background-size:200% 100%;animation:bg-gradient 12s ease infinite}.page #navigation a{color:#fff}.page #navigation button.link-like{color:#fff}.page #navigation button.link-like:hover,.page #navigation button.link-like:focus{box-shadow:0 2px #fff}.page #navigation .dropdown-content{background:#013567}.page #navigation .page-icon-wrapper{width:36px;height:36px;background:url("http://github.com/img/light-sidebar-brand.svg") no-repeat;margin-right:8px}.page-site-main{padding:40px 0}.page-site-main .use{flex:1 1 auto}.features-masthead{padding:130px 0}.features-image{width:49%;height:100%;background:url("http://github.com/img/features-header.svg") no-repeat;background-size:contain;background-position:center;position:absolute;top:0;right:0}.feature-header{display:flex;align-items:center;justify-content:space-between;height:100%;width:100%;position:relative}.feature-header .features-header-description{display:flex;flex-direction:column}.feature-header .features-header-description .masthead-title{font-size:3.5rem;font-weight:600;margin:0}.feature-header .features-header-description .masthead-description{font-size:1.65rem;margin:0 0 10px 0}.feature-header .features-header-description .masthead-button{text-align:center;width:106px;margin-top:16px}.features-header-description{max-width:49%}.features{display:flex;padding:100px 0}.features .feature-item{flex:1;align-items:center;text-align:center;min-height:240px;margin-right:40px;display:flex;flex-direction:column;justify-content:space-between;color:#333}.features .feature-item h4,.features .feature-item p{margin:8px 0 0 0}.features .feature-item:last-child{margin-right:0}.features .feature-item .first-feature-icon-wrapper,.features .feature-item .fourth-feature-icon-wrapper,.features .feature-item .second-feature-icon-wrapper,.features .feature-item .third-feature-icon-wrapper{margin-top:0;width:56px;min-height:56px;padding-bottom:8px}@keyframes subtle-transition{80%{background-color:#013567}95%{background-color:#333}}.features .feature-item .background-mask .first-feature-icon-wrapper{-webkit-mask:url("http://github.com/img/first-feature-icon.svg") no-repeat;mask:url("http://github.com/img/first-feature-icon.svg") no-repeat;background-color:#013567;animation:subtle-transition 6.66s infinite linear}.features .feature-item .background-mask .second-feature-icon-wrapper{-webkit-mask:url("http://github.com/img/second-feature-icon.svg") no-repeat;mask:url("http://github.com/img/second-feature-icon.svg") no-repeat;background-color:#013567;animation:subtle-transition 6.66s infinite linear}.features .feature-item .background-mask .third-feature-icon-wrapper{-webkit-mask:url("http://github.com/img/third-feature-icon.svg") no-repeat;mask:url("http://github.com/img/third-feature-icon.svg") no-repeat;background-color:#013567;animation:subtle-transition 6.66s infinite linear}.features .feature-item .custom-feature-icon .first-feature-icon-wrapper{background:url("http://github.com/img/first-feature-icon.svg") no-repeat}.features .feature-item .custom-feature-icon .second-feature-icon-wrapper{background:url("http://github.com/img/second-feature-icon.svg") no-repeat}.features .feature-item .custom-feature-icon .third-feature-icon-wrapper{background:url("http://github.com/img/third-feature-icon.svg") no-repeat}.features .feature-item .feature-item-header{display:flex;flex-direction:column;align-items:center;flex:1 0 auto}#site-main .learn-more-button{padding:6px 24px;font-size:14px;color:#013567;border:2px solid #013567;font-weight:600;border-radius:2px;transition:all 350ms ease;width:80px;text-decoration:none;margin-top:16px}#site-main .learn-more-button:hover{background-color:#013567;color:#fff}@media (max-width: 868px){.feature-header{justify-content:center;text-align:center;padding:0}.feature-header .features-image{display:none}.feature-header .features-header-description{max-width:100%;align-items:center;padding:48px 0}.feature-header .features-header-description .masthead-title{font-size:2rem}.feature-header .features-header-description .masthead-description{font-size:1.25rem}.features{flex-direction:column;padding:0}.features .feature-item{min-height:220px;width:80%;margin:48px auto}.features .feature-item:last-child{margin-right:auto}}table{background-color:rgba(0,0,0,0);border:1px solid #DDD;border-collapse:collapse}table>tbody>tr>td,table>tbody>tr>th,table>thead>tr>td,table>thead>tr>th,table>tfoot>tr>td,table>tfoot>tr>th{border:1px solid #DDD;padding:8px;text-align:left}caption{padding-top:8px;padding-bottom:8px;color:#E3E2E3;text-align:left}th{text-align:left}.table{width:100%;max-width:100%;margin-bottom:20px}.table>tbody>tr>td,.table>tbody>tr>th,.table>thead>tr>td,.table>thead>tr>th,.table>tfoot>tr>td,.table>tfoot>tr>th{padding:8px;line-height:1.428571429;vertical-align:top;border-top:1px solid #DDD}.table>thead>tr>th{vertical-align:bottom;border-bottom:2px solid #DDD}.table>colgroup+thead>tr:first-child>td,.table>colgroup+thead>tr:first-child>th,.table>thead:first-child>tr:first-child>td,.table>thead:first-child>tr:first-child>th,.table>caption+thead>tr:first-child>td,.table>caption+thead>tr:first-child>th{border-top:0}.table>tbody+tbody{border-top:2px solid #DDD}.table .table{background-color:#fff}.table-condensed>tbody>tr>td,.table-condensed>tbody>tr>th,.table-condensed>thead>tr>td,.table-condensed>thead>tr>th,.table-condensed>tfoot>tr>td,.table-condensed>tfoot>tr>th{padding:5px}.table-bordered{border:1px solid #DDD}.table-bordered>tbody>tr>td,.table-bordered>tbody>tr>th,.table-bordered>thead>tr>td,.table-bordered>thead>tr>th,.table-bordered>tfoot>tr>td,.table-bordered>tfoot>tr>th{border:1px solid #DDD}.table-bordered>thead>tr>td,.table-bordered>thead>tr>th{border-bottom-width:2px}.table-striped>tbody>tr:nth-of-type(odd){background-color:#F9F9F9}.table-hover>tbody>tr:hover{background-color:#f5f5f5}table col[class*="col-"]{position:static;float:none;display:table-column}table td[class*="col-"],table th[class*="col-"]{position:static;float:none;display:table-cell}.table>thead>tr>td.active,.table>thead>tr>th.active,.table>thead>tr.active>td,.table>thead>tr.active>th,.table>tbody>tr>td.active,.table>tbody>tr>th.active,.table>tbody>tr.active>td,.table>tbody>tr.active>th,.table>tfoot>tr>td.active,.table>tfoot>tr>th.active,.table>tfoot>tr.active>td,.table>tfoot>tr.active>th{background-color:#f5f5f5}.table-hover>tbody>tr>td.active:hover,.table-hover>tbody>tr>th.active:hover,.table-hover>tbody>tr.active:hover>td,.table-hover>tbody>tr:hover>.active,.table-hover>tbody>tr.active:hover>th{background-color:#e8e8e8}.table>thead>tr>td.success,.table>thead>tr>th.success,.table>thead>tr.success>td,.table>thead>tr.success>th,.table>tbody>tr>td.success,.table>tbody>tr>th.success,.table>tbody>tr.success>td,.table>tbody>tr.success>th,.table>tfoot>tr>td.success,.table>tfoot>tr>th.success,.table>tfoot>tr.success>td,.table>tfoot>tr.success>th{background-color:#dff0d8}.table-hover>tbody>tr>td.success:hover,.table-hover>tbody>tr>th.success:hover,.table-hover>tbody>tr.success:hover>td,.table-hover>tbody>tr:hover>.success,.table-hover>tbody>tr.success:hover>th{background-color:#d0e9c6}.table>thead>tr>td.info,.table>thead>tr>th.info,.table>thead>tr.info>td,.table>thead>tr.info>th,.table>tbody>tr>td.info,.table>tbody>tr>th.info,.table>tbody>tr.info>td,.table>tbody>tr.info>th,.table>tfoot>tr>td.info,.table>tfoot>tr>th.info,.table>tfoot>tr.info>td,.table>tfoot>tr.info>th{background-color:#d9edf7}.table-hover>tbody>tr>td.info:hover,.table-hover>tbody>tr>th.info:hover,.table-hover>tbody>tr.info:hover>td,.table-hover>tbody>tr:hover>.info,.table-hover>tbody>tr.info:hover>th{background-color:#c4e3f3}.table>thead>tr>td.warning,.table>thead>tr>th.warning,.table>thead>tr.warning>td,.table>thead>tr.warning>th,.table>tbody>tr>td.warning,.table>tbody>tr>th.warning,.table>tbody>tr.warning>td,.table>tbody>tr.warning>th,.table>tfoot>tr>td.warning,.table>tfoot>tr>th.warning,.table>tfoot>tr.warning>td,.table>tfoot>tr.warning>th{background-color:#fcf8e3}.table-hover>tbody>tr>td.warning:hover,.table-hover>tbody>tr>th.warning:hover,.table-hover>tbody>tr.warning:hover>td,.table-hover>tbody>tr:hover>.warning,.table-hover>tbody>tr.warning:hover>th{background-color:#faf2cc}.table>thead>tr>td.danger,.table>thead>tr>th.danger,.table>thead>tr.danger>td,.table>thead>tr.danger>th,.table>tbody>tr>td.danger,.table>tbody>tr>th.danger,.table>tbody>tr.danger>td,.table>tbody>tr.danger>th,.table>tfoot>tr>td.danger,.table>tfoot>tr>th.danger,.table>tfoot>tr.danger>td,.table>tfoot>tr.danger>th{background-color:#f2dede}.table-hover>tbody>tr>td.danger:hover,.table-hover>tbody>tr>th.danger:hover,.table-hover>tbody>tr.danger:hover>td,.table-hover>tbody>tr:hover>.danger,.table-hover>tbody>tr.danger:hover>th{background-color:#ebcccc}.table-responsive{overflow-x:auto;min-height:0.01%}@media screen and (max-width: 768px){.table-responsive{width:100%;margin-bottom:15px;overflow-y:hidden;-ms-overflow-style:-ms-autohiding-scrollbar;border:1px solid #DDD}.table-responsive>.table{margin-bottom:0}.table-responsive>.table>tbody>tr>td,.table-responsive>.table>tbody>tr>th,.table-responsive>.table>thead>tr>td,.table-responsive>.table>thead>tr>th,.table-responsive>.table>tfoot>tr>td,.table-responsive>.table>tfoot>tr>th{white-space:nowrap}.table-responsive>.table-bordered{border:0}.table-responsive>.table-bordered>tbody>tr>td:first-child,.table-responsive>.table-bordered>tbody>tr>th:first-child,.table-responsive>.table-bordered>thead>tr>td:first-child,.table-responsive>.table-bordered>thead>tr>th:first-child,.table-responsive>.table-bordered>tfoot>tr>td:first-child,.table-responsive>.table-bordered>tfoot>tr>th:first-child{border-left:0}.table-responsive>.table-bordered>tbody>tr>td:last-child,.table-responsive>.table-bordered>tbody>tr>th:last-child,.table-responsive>.table-bordered>thead>tr>td:last-child,.table-responsive>.table-bordered>thead>tr>th:last-child,.table-responsive>.table-bordered>tfoot>tr>td:last-child,.table-responsive>.table-bordered>tfoot>tr>th:last-child{border-right:0}.table-responsive>.table-bordered>tfoot>tr:last-child>td,.table-responsive>.table-bordered>tfoot>tr:last-child>th,.table-responsive>.table-bordered>tbody>tr:last-child>td,.table-responsive>.table-bordered>tbody>tr:last-child>th{border-bottom:0}} diff --git a/docs/blogposts.html b/docs/blogposts.html new file mode 100644 index 00000000..7ebbe3e8 --- /dev/null +++ b/docs/blogposts.html @@ -0,0 +1,36 @@ +prox: Blog posts \ No newline at end of file diff --git a/docs/docs/docs/blogposts.md b/docs/docs/docs/blogposts.md deleted file mode 100644 index 7c85db30..00000000 --- a/docs/docs/docs/blogposts.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: docs -title: Blog posts ---- -# Blog posts - -The following series of blog posts are based on the development of `prox`: - -- [Part 1 - type level programming](https://vigoo.github.io/posts/2019-02-10-prox-1-types.html) -- [Part 2 - Akka Streams with Cats Effect](https://vigoo.github.io/posts/2019-03-07-prox-2-io-akkastreams.html) -- [Part 3 - Effect abstraction and ZIO](https://vigoo.github.io/posts/2019-08-13-prox-3-zio.html) -- [Part 4 - Simplified redesign](https://vigoo.github.io/posts/2020-08-03-prox-4-simplify.html) diff --git a/docs/docs/docs/fs2/custom-runners.md b/docs/docs/docs/fs2/custom-runners.md deleted file mode 100644 index 62ea841f..00000000 --- a/docs/docs/docs/fs2/custom-runners.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -layout: docs -title: Custom runners ---- - -# Customizing the runner - -```scala mdoc:invisible -import cats.effect._ -import cats.Traverse -import scala.concurrent.ExecutionContext -import io.github.vigoo.prox._ - -val prox = ProxFS2[IO] -import prox._ -``` - -The _runner_ is responsible for stating the native processes and wiring all the redirections together. The default -implementation is called `JVMProcessRunner`. - -There are use cases when providing a custom runner makes sense. One such use case could be to launch external processes -within a docker container in case of running on a development machine (for example from tests), while running them directly -in production, when the whole service is running within the container. - -We can implement this scenario by using `JVMProcessRunner` in production and a custom `DockerizedProcessRunner` in tests, -where we define the latter as follows: - -```scala mdoc -import java.nio.file.Path -import java.util.UUID - -case class DockerImage(name: String) - -case class DockerContainer(name: String) - -case class DockerProcessInfo[DockerProcessInfo](container: DockerContainer, dockerProcessInfo: DockerProcessInfo) - -class DockerizedProcessRunner[Info](processRunner: ProcessRunner[Info], - mountedDirectory: Path, - workingDirectory: Path, - image: DockerImage) - extends ProcessRunner[DockerProcessInfo[Info]] { - - override def startProcess[O, E](process: Process[O, E]): IO[RunningProcess[O, E, DockerProcessInfo[Info]]] = { - for { - container <- generateContainerName - runningProcess <- processRunner - .startProcess(wrapInDocker(process, container)) - } yield runningProcess.mapInfo(info => DockerProcessInfo(container, info)) - } - - override def startProcessGroup[O, E](processGroup: ProcessGroup[O, E]): IO[RunningProcessGroup[O, E, DockerProcessInfo[Info]]] = { - Traverse[Vector].sequence(processGroup.originalProcesses.toVector.map(key => generateContainerName.map(c => key -> c))).flatMap { keyAndNames => - val nameMap = keyAndNames.toMap - val names = keyAndNames.map(_._2) - val modifiedProcessGroup = processGroup.map(new ProcessGroup.Mapper[O, E] { - def mapFirst[P <: Process[fs2.Stream[IO, Byte], E]](process: P): P = wrapInDocker(process, names.head).asInstanceOf[P] - def mapInnerWithIdx[P <: Process.UnboundIProcess[fs2.Stream[IO, Byte], E]](process: P, idx: Int): P = - wrapInDocker(process, names(idx)).asInstanceOf[P] - def mapLast[P <: Process.UnboundIProcess[O, E]](process: P): P = wrapInDocker(process, names.last).asInstanceOf[P] - }) - processRunner.startProcessGroup(modifiedProcessGroup) - .map(_.mapInfo { case (key, info) => DockerProcessInfo(nameMap(key), info) }) - } - } - - private def generateContainerName: IO[DockerContainer] = - IO(DockerContainer(UUID.randomUUID().toString)) - - private def wrapInDocker[O, E](process: Process[O, E], container: DockerContainer): Process[O, E] = { - val envVars = process.environmentVariables.flatMap { case (key, value) => List("-e", s"$key=$value") }.toList - process.withCommand("docker").withArguments( - "run" :: - "--name" :: container.name :: - "-v" :: mountedDirectory.toString :: - "-w" :: workingDirectory.toString :: - envVars ::: - List(image.name, process.command) ::: - process.arguments - ) - } -} -``` diff --git a/docs/docs/docs/fs2/customize.md b/docs/docs/docs/fs2/customize.md deleted file mode 100644 index a78b7e5f..00000000 --- a/docs/docs/docs/fs2/customize.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -layout: docs -title: Customizing environment ---- - -# Customizing the environment - -```scala mdoc:invisible -import cats.effect._ -import scala.concurrent.ExecutionContext -import io.github.vigoo.prox._ - -val prox = ProxFS2[IO] -import prox._ -``` - -The type returned by the `Process` constructor also implements the `ProcessConfiguration` trait, -adding three methods that can be used to customize the working environment of the process to be started: - -### Working directory - -The `in` method can be used to customize the working directory: - -```scala mdoc -import io.github.vigoo.prox.path._ - -val dir = home / "tmp" -val proc1 = Process("ls") in dir -``` - -Not that `dir` has the type `java.nio.file.Path`, and the `home / tmp` syntax is just a thin -syntax extension to produce such values. - -### Adding environment variables - -The `with` method can be used to add environment variables to the process in the following -way: - -```scala mdoc -val proc2 = Process("echo", List("$TEST")) `with` ("TEST" -> "Hello world") -``` - -### Removing environment variables - -The subprocess inherits the parent process environment, so it may be necessary to -_remove_ some already defined environment variables with the `without` method: - -```scala mdoc -val proc3 = Process("echo" , List("$PATH")) `without` "PATH" -``` - -### Writing reusable functions - -Because these methods are part of the `ProcessConfiguration` _capability_, writing reusable functions require us to define -a polymorphic function that requires this capability: - -```scala mdoc -import java.nio.file.Path - -def withHome[P <: ProcessLike with ProcessLikeConfiguration](home: Path, proc: P): P#Self = - proc `with` ("HOME" -> home.toString) -``` - -Then we can use it on any kind of process or process group (read about [redirection](redirection) to understand -why there are multiple concrete process types): - -```scala mdoc -val proc4 = Process("echo", List("$HOME")) -val proc5 = withHome(home, proc4) - -val group1 = Process("grep", List("ERROR")) | Process("sort") -val group2 = withHome(home, group1) -``` diff --git a/docs/docs/docs/fs2/index.md b/docs/docs/docs/fs2/index.md deleted file mode 100644 index 30a3eece..00000000 --- a/docs/docs/docs/fs2/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: docs -title: Getting started ---- - -# Getting started with prox - -First add one of the `prox` interfaces as a dependency: - -```sbt -libraryDependencies += "io.github.vigoo" %% "prox-fs2" % "0.7.3" -``` - -or for Cats Effect 3.x / FS2 3.x: - -```sbt -libraryDependencies += "io.github.vigoo" %% "prox-fs2-3" % "0.7.3" -``` - -and, assuming that we have a long living `Blocker` thread pool defined already, we can create -the `Prox` module: - -```scala mdoc:invisible -import cats.effect._ -import scala.concurrent.ExecutionContext -import io.github.vigoo.prox._ -``` - -```scala mdoc -val prox = ProxFS2[IO] -import prox._ -``` - -We require `F` to implement the `Concurrent` type class, and for that we have to have an implicit -_context shifter_ in scope (this should be already available in an application using cats-effect). - -### Defining a process to run -In prox a process to be executed is defined by a pure value which implements the `Process[O, E]` trait. -The type parameters have the following meaning: - -- `O` is the type of the output value after the system process has finished running -- `E` is the type of the error output value after the system process has finished running - -To create a simple process to be executed use the `Process` constructor: - -```scala mdoc -val proc1 = Process("ls", List("-hal")) -``` - -or we can use the _string interpolator_: - -```scala mdoc -val proc2 = proc"ls -hal" -``` - -Then we can -- [customize the process execution](customize) by for example setting environment variables and working directory -- and [redirect the input, output and error](redirection) channels of the process -- [pipe two or more processes together](processgroups) - -still staying on purely specification level. - -### Running the process - -Once we have our process specification ready, we can _start_ the process with one of the -IO functions on process. - -But for this we first have to have a `ProcessRunner` implementation in scope. The default -one is called `JVMProcessRunner` and it can be created in the following way: - -```scala mdoc:silent -implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner -``` - -Read the [custom process runners](custom-runners) page for an example of using a customized runner. - -With the runner in place we can use [several methods to start the process](running). -The simplest one is called `run` and it blocks the active thread until the process finishes -running: - -```scala mdoc -proc1.run() -``` - -The result of this IO action is a `ProcessResult[O, E]`, with the ability to observe the -_exit code_ and the redirected output and error values. In our first example both `O` and -`E` were `Unit` because the default is to redirect output and error to the _standard output_ and -_standard error_ streams. diff --git a/docs/docs/docs/fs2/processgroups.md b/docs/docs/docs/fs2/processgroups.md deleted file mode 100644 index 64945a6f..00000000 --- a/docs/docs/docs/fs2/processgroups.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: docs -title: Process groups ---- - -# Connecting processes together via pipes -```scala mdoc:invisible -import cats.effect._ -import scala.concurrent.ExecutionContext -import io.github.vigoo.prox._ - -val prox = ProxFS2[IO] -import prox._ -``` - -Connecting one process to another means that the standard output of the first process -gets redirected to the standard input of the second process. This is implemented using -the redirection capabilities described [on the redirection page](redirection). The result -of connecting one process to another is called a _process group_ and it implements the -trait `ProcessGroup[O, E]`. - -To create a process group, either: -- Use the `|` or `via` methods between two **unbounded** processes -- Use the `|` or `via` methods between an **unbounded** process group and an **unbounded** process - -It is important that the process group construction must always happen before any redirection, -the type system enforces this by requiring the involved processes to be `UnboundedProcess`. - -> :bulb: `Process.UnboundedProcess` is a type alias for a process with all the redirection capabilities - -Let's see an example of simply piping: - -```scala mdoc:silent -val group1 = Process("grep", List("ERROR")) | Process("sort") -val group2 = group1 | Process("uniq", List("-c")) -``` - -A custom pipe (when using `via`) can be anything of the type `Pipe[F, Byte, Byte]`. The -following not very useful example capitalizes each word coming through: - -```scala mdoc:silent -val customPipe: fs2.Pipe[IO, Byte, Byte] = - (s: fs2.Stream[IO, Byte]) => s - .through(fs2.text.utf8.decode) // decode UTF-8 - .through(fs2.text.lines) // split to lines - .map(_.split(' ').toVector) // split lines to words - .map(v => v.map(_.capitalize).mkString(" ")) - .intersperse("\n") // remerge lines - .through(fs2.text.utf8.encode) // encode as UTF-8 - -val group3 = Process("echo", List("hello world")).via(customPipe).to(Process("wc", List("-w"))) -``` \ No newline at end of file diff --git a/docs/docs/docs/fs2/redirection.md b/docs/docs/docs/fs2/redirection.md deleted file mode 100644 index c8093e97..00000000 --- a/docs/docs/docs/fs2/redirection.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -layout: docs -title: Redirection ---- - -# Redirecting input, output and error - -```scala mdoc:invisible -import cats.effect._ -import scala.concurrent.ExecutionContext -import io.github.vigoo.prox._ - -val prox = ProxFS2[IO] -import prox._ -``` - -Similarly to [customization](customize), redirection is also implemented with _capability traits_. -The `ProcessIO` type returned by the `Process` constructor implements all the three redirection capability -traits: - -- `RedirectableInput` marks that the standard input of the process is not bound yet -- `RedirectableOutput` marks that the standard output of the process is not bound yet -- `RedirectableError` marks that the standard error output of the process is not bound yet - -Each of the three channels can be **only redirected once**. The result type of each redirection method no longer -implements the given capability. - -Let's see an example of this (redirection methods are described below on this page): - -```scala mdoc -import cats.implicits._ - -val proc1 = Process("echo", List("Hello world")) -val proc2 = proc1 ># fs2.text.utf8.decode -``` - -It is no longer possible to redirect the output of `proc2`: - -```scala mdoc:fail -val proc3 = proc2 >? fs2.text.utf8.decode[IO].andThen(fs2.text.lines) -``` - -Many redirection methods have an _operator_ version but all of them have alphanumberic -variants as well. - -### Input redirection -Input redirection is enabled by the `RedirectableInput` trait. The following operations -are supported: - -| operator | alternative | parameter type | what it does | -|----------|--------------|----------------------|---------------| -| `<` | `fromFile` | `java.nio.file.Path` | Natively attach a source file to STDIN | -| `<` | `fromStream` | `Stream[F, Byte]` | Attach an _fs2 byte stream_ to STDIN | -| `!<` | `fromStream` | `Stream[F, Byte]` | Attach an _fs2 byte stream_ to STDIN and **flush** after each chunk | - -### Output redirection -Output redirection is enabled by the `RedirectableOutput` trait. -The following operations are supported: - -| operator | alternative | parameter type | result type | what it does | -|----------|----------------|--------------------------------|-------------| --------------| -| `>` | `toFile` | `java.nio.file.Path` | `Unit` | Natively attach STDOUT to a file | -| `>>` | `appendToFile` | `java.nio.file.Path` | `Unit` | Natively attach STDOUT to a file in append mode | -| `>` | `toSink` | `Pipe[F, Byte, Unit]` | `Unit` | Drains the STDOUT through the given pipe | -| `>#` | `toFoldMonoid` | `[O: Monoid](Pipe[F, Byte, O]` | `O` | Sends STDOUT through the pipe and folds the result using its _monoid_ instance -| `>?` | `toVector` | `Pipe[F, Byte, O]` | `Vector[O]` | Sends STDOUT through the pipe and collects the results | -| | `drainOutput` | `Pipe[F, Byte, O]` | `Unit` | Drains the STDOUT through the given pipe | -| | `foldOutput` | `Pipe[F, Byte, O], R, (R, O) => R` | `R` | Sends STDOUT through the pipe and folds the result using a custom fold function | - -### Error redirection -Error redirection is enabled by the `RedirectableError` trait. -The following operations are supported: - -| operator | alternative | parameter type | result type | what it does | -|-----------|---------------------|--------------------------------|-------------| --------------| -| `!>` | `errorToFile` | `java.nio.file.Path` | `Unit` | Natively attach STDERR to a file | -| `!>>` | `appendErrorToFile` | `java.nio.file.Path` | `Unit` | Natively attach STDERR to a file in append mode | -| `!>` | `errorToSink` | `Pipe[F, Byte, Unit]` | `Unit` | Drains the STDERR through the given pipe | -| `!>#` | `errorToFoldMonoid` | `[O: Monoid](Pipe[F, Byte, O]` | `O` | Sends STDERR through the pipe and folds the result using its _monoid_ instance -| `!>?` | `errorToVector` | `Pipe[F, Byte, O]` | `Vector[O]` | Sends STDERR through the pipe and collects the results | -| | `drainError` | `Pipe[F, Byte, O]` | `Unit` | Drains the STDERR through the given pipe | -| | `foldError` | `Pipe[F, Byte, O], R, (R, O) => R` | `R` | Sends STDERR through the pipe and folds the result using a custom fold function | - -### Redirection for process groups -[Process groups](processgroups) are two or more processes attached together through pipes. -This connection is internally implemented using the above described redirection capabilities. -This means that all but the first process has their _inputs_ bound, and all but the last one has -their _outputs_ bound. Redirection of input and output for a _process group_ is thus a well defined -operation meaning redirection of input of the _first_ process and redirection of output of the _last process_. - -For this reason the class created via _process piping_ implements the `RedirectableInput` and -`RedirectableOutput` traits described above. - -For the sake of simplicity the library does not support anymore the fully customizable -per-process error redirection for process groups, but a reduced but still quite expressive -version described by the `RedirectableErrors` trait. - -The methods in this trait define error redirection for **all process in the group at once**: - -| operator | alternative | parameter type | result type | what it does | -|-----------|----------------------|--------------------------------|-------------| --------------| -| `!>` | `errorsToSink` | `Pipe[F, Byte, Unit]` | `Unit` | Drains the STDERR through the given pipe | -| `!>#` | `errorsToFoldMonoid` | `[O: Monoid](Pipe[F, Byte, O]` | `O` | Sends STDERR through the pipe and folds the result using its _monoid_ instance -| `!>?` | `errorsToVector` | `Pipe[F, Byte, O]` | `Vector[O]` | Sends STDERR through the pipe and collects the results | -| | `drainErrors` | `Pipe[F, Byte, O]` | `Unit` | Drains the STDERR through the given pipe | -| | `foldErrors` | `Pipe[F, Byte, O], R, (R, O) => R` | `R` | Sends STDERR through the pipe and folds the result using a custom fold function | - -Redirection to file is not possible through this interface as only a single path could be -provided. -The result of these redirections is accessible through the `ProcessGroupResult` interface as -it is described in the [running processes section](running). - -By using the `RedirectableErrors.customizedPerProcess` interface (having the type -`RedirectableErrors.CustomizedPerProcess`) it is possible to customize the redirection -targets per process while keeping their types uniform: - -| operator | alternative | parameter type | result type | what it does | -|-----------|----------------------|-----------------------------------------------|-------------| --------------| -| | `errorsToFile` | `Process => java.nio.file.Path` | `Unit` | Natively attach STDERR to a file | -| | `appendErrorsToFile` | `Process => java.nio.file.Path` | `Unit` | Natively attach STDERR to a file in append mode | -| | `errorsToSink` | `Process => Pipe[F, Byte, Unit]` | `Unit` | Drains the STDERR through the given pipe | -| | `errorsToFoldMonoid` | `Process => [O: Monoid](Pipe[F, Byte, O]` | `O` | Sends STDERR through the pipe and folds the result using its _monoid_ instance -| | `errorsToVector` | `Process => Pipe[F, Byte, O]` | `Vector[O]` | Sends STDERR through the pipe and collects the results | -| | `drainErrors` | `Process => Pipe[F, Byte, O]` | `Unit` | Drains the STDERR through the given pipe | -| | `foldErrors` | `Process => Pipe[F, Byte, O], R, (R, O) => R` | `R` | Sends STDERR through the pipe and folds the result using a custom fold function | - -Let's see an example of how this works! - -First we define a queue where we want to send _error lines_ from all the involved -processes, then we define the two processes separately, connect them with a pipe and -customize the error redirection where we prefix the parsed lines based on which -process they came from: - - -```scala mdoc:silent -import cats.effect.std.Queue - -for { - errors <- Queue.unbounded[IO, String] - parseLines = fs2.text.utf8.decode[IO].andThen(fs2.text.lines) - - p1 = Process("proc1") - p2 = Process("proc2") - group = (p1 | p2).customizedPerProcess.errorsToSink { - case p if p == p1 => parseLines.andThen(_.map(s => "P1: " + s)).andThen(_.evalMap(errors.offer)) - case p if p == p2 => parseLines.andThen(_.map(s => "P2: " + s)).andThen(_.evalMap(errors.offer)) - } -} yield () -``` - -### Creating reusable functions -The `Process` object contains several useful _type aliases_ for writing functions that work with any process by -only specifying what redirection channels we want _unbounded_. - -The `UnboundProcess` represents a process which is fully unbound, no redirection has been done yet. It is -defined as follows: - -```scala -type UnboundProcess = Process[Unit, Unit] - with RedirectableInput[UnboundOEProcess] - with RedirectableOutput[UnboundIEProcess[*]] - with RedirectableError[UnboundIOProcess[*]] -``` - -where `UnboundIOProcess[E]` for example represents a process which has its _error output_ already bound. - -These type aliases can be used to define functions performing redirection on arbitrary processes, for example: - -```scala mdoc -def logErrors[P <: Process.UnboundEProcess[_]](proc: P) = { - val target = fs2.text.utf8.decode[IO].andThen(fs2.text.lines).andThen(_.evalMap(line => IO(println(line)))) - proc !> target -} - -val proc4 = logErrors(Process("something")) -``` \ No newline at end of file diff --git a/docs/docs/docs/fs2/running.md b/docs/docs/docs/fs2/running.md deleted file mode 100644 index 083d336b..00000000 --- a/docs/docs/docs/fs2/running.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -layout: docs -title: Running processes ---- - -# Running processes and process groups -```scala mdoc:invisible -import io.github.vigoo.prox.zstream._ -``` - -There are three methods for running a _process_: - -- The `run` method is the simplest one, it starts the process and then blocks the current fiber until it terminates -- The `start` method starts the process and returns a fiber packed into a resource. The fiber finishes when the process terminates. Canceling the fiber terminates the process. -- The `startProcess` method returns a `RunningProcess[O, E]` interface that allows advanced some operations - -Similarly for a _process group_, there is a `run`, a `start` and a `startProcessGroup` method but with different result types. - -Let's see some examples! - -```scala mdoc:silent -implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner - -val process = Process("echo", List("hello")) - -val result1 = process.run() -val result2 = process.start().flatMap { fiber => - fiber.join -} - -val result3 = - for { - runningProcess <- process.startProcess() - _ <- runningProcess.kill() - } yield () -``` - -Both `RunningProcess` and `RunningProcessGroup` has the following methods: -- `waitForExit()` waits until the process terminates -- `terminate()` sends `SIGTERM` to the process -- `kill()` sends `SIGKILL` to the process - -In addition `RunningProcess` also defines an `isAlive` check. - -### Process execution result -The result of a process is represented by `ProcessResult[O, E]` defined as follows: - -```scala -trait ProcessResult[+O, +E] { - val exitCode: ExitCode - val output: O - val error: E -} -``` - -The type and value of `output` and `error` depends on what [redirection was defined](redirection) on the process. - -### Process group execution result -The result of a process group is represented by `ProcessGroupResult[O, E]`: - -```scala -trait ProcessGroupResult[+O, +E] { - val exitCodes: Map[Process[Unit, Unit], ExitCode] - val output: O - val errors: Map[Process[Unit, Unit], E] -} -``` - -The keys of the maps are the original _process_ values used in the piping operations. \ No newline at end of file diff --git a/docs/docs/docs/index.md b/docs/docs/docs/index.md deleted file mode 100644 index 40b6a585..00000000 --- a/docs/docs/docs/index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: docs -title: Getting started ---- - -Prox has two different interfaces: -- [Cats Effect with FS2](fs2/index) -- [ZIO with ZStream](zstream/index) - diff --git a/docs/docs/docs/migration.md b/docs/docs/docs/migration.md deleted file mode 100644 index b6244296..00000000 --- a/docs/docs/docs/migration.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: docs -title: Migration ---- -# Migration - -### from 0.1.x to 0.2 - -- The `start` method on processes now requires a `blockingExecutionContext` argument -- `Ignore` has been renamed to `Drain` -- `Log` has been renamed to `ToVector` - -### from 0.2 to 0.4 - -- `Process` now takes the effect type as parameter, so in case of cats-effect, `Process(...)` becomes `Process[IO](...)` -- The `start` method on processes now gets a `Blocker` instead of an execution context - -### from 0.4 to 0.5 - -0.5 is a complete rewrite of the original library, and the API changed a lot, especially -if the process types were used in code to pass around / wrap them. Please refer to the other -sections of the documentation to learn how to reimplement them. For simple use cases where -constructing and running the processes directly the main differences are: - -- Different operators / methods for different source and target types, see [the page about redirection](redirection) -- The need of an implicit [process runner](running) in scope -- New ways to start and wait for the process, see [the page about runnning processes](running) - -### from 0.5 to 0.6 - -0.6 introduces the native ZIO/ZStream version of the library. For existing code the following differences apply: - -- Instead of `prox`, the artifact is now called `prox-fs2` -- Instead of _global imports_, the FS2 prox module now has to be constructed with the `FS2` constructor and the API is imported from that -- Because the `FS2` module captures the `F[_]` and the `Blocker`, they are no longer needed to pass on to the API functions and types diff --git a/docs/docs/docs/zstream/custom-runners.md b/docs/docs/docs/zstream/custom-runners.md deleted file mode 100644 index a5a975e8..00000000 --- a/docs/docs/docs/zstream/custom-runners.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -layout: docs -title: Custom runners ---- - -# Customizing the runner - -```scala mdoc:invisible -import zio._ -import zio.stream._ -import io.github.vigoo.prox._ -import io.github.vigoo.prox.zstream._ -``` - -The _runner_ is responsible for stating the native processes and wiring all the redirections together. The default -implementation is called `JVMProcessRunner`. - -There are use cases when providing a custom runner makes sense. One such use case could be to launch external processes -within a docker container in case of running on a development machine (for example from tests), while running them directly -in production, when the whole service is running within the container. - -We can implement this scenario by using `JVMProcessRunner` in production and a custom `DockerizedProcessRunner` in tests, -where we define the latter as follows: - -```scala mdoc -import java.nio.file.Path -import java.util.UUID - -case class DockerImage(name: String) - -case class DockerContainer(name: String) - -case class DockerProcessInfo[DockerProcessInfo](container: DockerContainer, dockerProcessInfo: DockerProcessInfo) - -class DockerizedProcessRunner[Info](processRunner: ProcessRunner[Info], - mountedDirectory: Path, - workingDirectory: Path, - image: DockerImage) - extends ProcessRunner[DockerProcessInfo[Info]] { - - override def startProcess[O, E](process: Process[O, E]): ZIO[Any, ProxError, RunningProcess[O, E, DockerProcessInfo[Info]]] = { - for { - container <- generateContainerName - runningProcess <- processRunner - .startProcess(wrapInDocker(process, container)) - } yield runningProcess.mapInfo(info => DockerProcessInfo(container, info)) - } - - override def startProcessGroup[O, E](processGroup: ProcessGroup[O, E]): ZIO[Any, ProxError, RunningProcessGroup[O, E, DockerProcessInfo[Info]]] = { - ZIO.foreach(processGroup.originalProcesses.toVector)(key => generateContainerName.map(c => key -> c)).flatMap { keyAndNames => - val nameMap = keyAndNames.toMap - val names = keyAndNames.map(_._2) - val modifiedProcessGroup = processGroup.map(new ProcessGroup.Mapper[O, E] { - def mapFirst[P <: Process[ZStream[Any, ProxError, Byte], E]](process: P): P = wrapInDocker(process, names.head).asInstanceOf[P] - def mapInnerWithIdx[P <: Process.UnboundIProcess[ZStream[Any, ProxError, Byte], E]](process: P, idx: Int): P = - wrapInDocker(process, names(idx)).asInstanceOf[P] - def mapLast[P <: Process.UnboundIProcess[O, E]](process: P): P = wrapInDocker(process, names.last).asInstanceOf[P] - }) - processRunner.startProcessGroup(modifiedProcessGroup) - .map(_.mapInfo { case (key, info) => DockerProcessInfo(nameMap(key), info) }) - } - } - - private def generateContainerName: ZIO[Any, ProxError, DockerContainer] = - ZIO.attempt(DockerContainer(UUID.randomUUID().toString)).mapError(UnknownProxError) - - private def wrapInDocker[O, E](process: Process[O, E], container: DockerContainer): Process[O, E] = { - val envVars = process.environmentVariables.flatMap { case (key, value) => List("-e", s"$key=$value") }.toList - process.withCommand("docker").withArguments( - "run" :: - "--name" :: container.name :: - "-v" :: mountedDirectory.toString :: - "-w" :: workingDirectory.toString :: - envVars ::: - List(image.name, process.command) ::: - process.arguments - ) - } -} -``` diff --git a/docs/docs/docs/zstream/customize.md b/docs/docs/docs/zstream/customize.md deleted file mode 100644 index 53b97a47..00000000 --- a/docs/docs/docs/zstream/customize.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -layout: docs -title: Customizing environment ---- - -# Customizing the environment - -```scala mdoc:invisible -import io.github.vigoo.prox.zstream._ -import io.github.vigoo.prox._ -``` - -The type returned by the `Process` constructor also implements the `ProcessConfiguration` trait, -adding three methods that can be used to customize the working environment of the process to be started: - -### Working directory - -The `in` method can be used to customize the working directory: - -```scala mdoc -import io.github.vigoo.prox.path._ - -val dir = home / "tmp" -val proc1 = Process("ls") in dir -``` - -Not that `dir` has the type `java.nio.file.Path`, and the `home / tmp` syntax is just a thin -syntax extension to produce such values. - -### Adding environment variables - -The `with` method can be used to add environment variables to the process in the following -way: - -```scala mdoc -val proc2 = Process("echo", List("$TEST")) `with` ("TEST" -> "Hello world") -``` - -### Removing environment variables - -The subprocess inherits the parent process environment, so it may be necessary to -_remove_ some already defined environment variables with the `without` method: - -```scala mdoc -val proc3 = Process("echo" , List("$PATH")) `without` "PATH" -``` - -### Writing reusable functions - -Because these methods are part of the `ProcessConfiguration` _capability_, writing reusable functions require us to define -a polymorphic function that requires this capability: - -```scala mdoc -import java.nio.file.Path - -def withHome[P <: ProcessLike with ProcessLikeConfiguration](home: Path, proc: P): P#Self = - proc `with` ("HOME" -> home.toString) -``` - -Then we can use it on any kind of process or process group (read about [redirection](redirection) to understand -why there are multiple concrete process types): - -```scala mdoc -val proc4 = Process("echo", List("$HOME")) -val proc5 = withHome(home, proc4) - -val group1 = Process("grep", List("ERROR")) | Process("sort") -val group2 = withHome(home, group1) -``` \ No newline at end of file diff --git a/docs/docs/docs/zstream/index.md b/docs/docs/docs/zstream/index.md deleted file mode 100644 index 27e504e8..00000000 --- a/docs/docs/docs/zstream/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -layout: docs -title: Getting started ---- - -# Getting started with prox - -First add one of the `prox` interfaces as a dependency: - -```sbt -libraryDependencies += "io.github.vigoo" %% "prox-zstream" % "0.7.3" -``` - -and import the ZIO specific API from: - -```scala mdoc -import io.github.vigoo.prox._ -import io.github.vigoo.prox.zstream._ -``` - -There is also an experimental version for ZIO 2, based on it's snapshot releases: - -```sbt -libraryDependencies += "io.github.vigoo" %% "prox-zstream-2" % "0.7.3" -``` - -The code snippets in the documentation are based on the ZIO 1 version. - -### Defining a process to run -In prox a process to be executed is defined by a pure value which implements the `Process[O, E]` trait. -The type parameters have the following meaning: - -- `O` is the type of the output value after the system process has finished running -- `E` is the type of the error output value after the system process has finished running - -To create a simple process to be executed use the `Process` constructor: - -```scala mdoc -val proc1 = Process("ls", List("-hal")) -``` - -or we can use the _string interpolator_: - -```scala mdoc -val proc2 = proc"ls -hal" -``` - -Then we can -- [customize the process execution](customize) by for example setting environment variables and working directory -- and [redirect the input, output and error](redirection) channels of the process -- [pipe two or more processes together](processgroups) - -still staying on purely specification level. - -### Running the process - -Once we have our process specification ready, we can _start_ the process with one of the -IO functions on process. - -But for this we first have to have a `ProcessRunner` implementation in scope. The default -one is called `JVMProcessRunner` and it can be created in the following way: - -```scala mdoc:silent -implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner -``` - -Read the [custom process runners](custom-runners) page for an example of using a customized runner. - -With the runner in place we can use [several methods to start the process](running). -The simplest one is called `run` and it blocks the active thread until the process finishes -running: - -```scala mdoc -proc1.run() -``` - -The result of this IO action is a `ProcessResult[O, E]`, with the ability to observe the -_exit code_ and the redirected output and error values. In our first example both `O` and -`E` were `Unit` because the default is to redirect output and error to the _standard output_ and -_standard error_ streams. diff --git a/docs/docs/docs/zstream/processgroups.md b/docs/docs/docs/zstream/processgroups.md deleted file mode 100644 index 5470bbe2..00000000 --- a/docs/docs/docs/zstream/processgroups.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: docs -title: Process groups ---- - -# Connecting processes together via pipes -```scala mdoc:invisible -import zio._ -import zio.stream._ -import zio.prelude._ -import io.github.vigoo.prox._ -import io.github.vigoo.prox.zstream._ -import java.nio.charset.StandardCharsets -``` - -Connecting one process to another means that the standard output of the first process -gets redirected to the standard input of the second process. This is implemented using -the redirection capabilities described [on the redirection page](redirection). The result -of connecting one process to another is called a _process group_ and it implements the -trait `ProcessGroup[O, E]`. - -To create a process group, either: -- Use the `|` or `via` methods between two **unbounded** processes -- Use the `|` or `via` methods between an **unbounded** process group and an **unbounded** process - -It is important that the process group construction must always happen before any redirection, -the type system enforces this by requiring the involved processes to be `UnboundedProcess`. - -> :bulb: `Process.UnboundedProcess` is a type alias for a process with all the redirection capabilities - -Let's see an example of simply pipeing: - -```scala mdoc:silent -val group1 = Process("grep", List("ERROR")) | Process("sort") -val group2 = group1 | Process("uniq", List("-c")) -``` - -A custom pipe (when using `via`) can be anything of the type `ZStream[any, ProxError, Byte] => ZStream[any, ProxError, Byte])`. -The following not very useful example capitalizes each word coming through: - -```scala mdoc:silent -val customPipe: ProxPipe[Byte, Byte] = - (s: ZStream[Any, ProxError, Byte]) => s - .via(ZPipeline.utf8Decode.mapError(UnknownProxError.apply)) // decode UTF-8 - .via(ZPipeline.splitLines) // split to lines - .map(_.split(' ').toVector) // split lines to words - .map(v => v.map(_.capitalize).mkString(" ")) - .intersperse("\n") // remerge lines - .flatMap(str => ZStream.fromIterable(str.getBytes(StandardCharsets.UTF_8))) // reencode - -val group3 = Process("echo", List("hello world")).via(customPipe).to(Process("wc", List("-w"))) -``` \ No newline at end of file diff --git a/docs/docs/docs/zstream/redirection.md b/docs/docs/docs/zstream/redirection.md deleted file mode 100644 index b1f04bfd..00000000 --- a/docs/docs/docs/zstream/redirection.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: docs -title: Redirection ---- - -# Redirecting input, output and error - -```scala mdoc:invisible -import io.github.vigoo.prox._ -import io.github.vigoo.prox.zstream._ -``` - -Similarly to [customization](customize), redirection is also implemented with _capability traits_. -The `ProcessIO` type returned by the `Process` constructor implements all the three redirection capability -traits: - -- `RedirectableInput` marks that the standard input of the process is not bound yet -- `RedirectableOutput` marks that the standard output of the process is not bound yet -- `RedirectableError` marks that the standard error output of the process is not bound yet - -Each of the three channels can be **only redirected once**. The result type of each redirection method no longer -implements the given capability. - -Let's see an example of this (redirection methods are described below on this page): - -```scala mdoc -import zio._ -import zio.stream._ -import zio.prelude._ - -val proc1 = Process("echo", List("Hello world")) -val proc2 = proc1 ># ZPipeline.utf8Decode -``` - -It is no longer possible to redirect the output of `proc2`: - -```scala mdoc:fail -val proc3 = proc2 >? (ZPipeline.utf8Decode >>> ZPipeline.splitLines) -``` - -Many redirection methods have an _operator_ version but all of them have alphanumberic -variants as well. - -### Input redirection -Input redirection is enabled by the `RedirectableInput` trait. The following operations -are supported: - -| operator | alternative | parameter type | what it does | -|----------|--------------|---------------------------------|---------------| -| `<` | `fromFile` | `java.nio.file.Path` | Natively attach a source file to STDIN | -| `<` | `fromStream` | `ZStream[Any, ProxError, Byte]` | Attach a _ZIO byte stream_ to STDIN | -| `!<` | `fromStream` | `ZStream[Any, ProxError, Byte]` | Attach a _ZIO byte stream_ to STDIN and **flush** after each chunk | - -### Output redirection -Output redirection is enabled by the `RedirectableOutput` trait. -The following operations are supported: - -| operator | alternative | parameter type | result type | what it does | -|----------|----------------|--------------------------------------------------------------------------------|-------------| --------------| -| `>` | `toFile` | `java.nio.file.Path` | `Unit` | Natively attach STDOUT to a file | -| `>>` | `appendToFile` | `java.nio.file.Path` | `Unit` | Natively attach STDOUT to a file in append mode | -| `>` | `toSink` | `TransformAndSink[Byte, _]` | `Unit` | Drains the STDOUT through the given sink | -| `>#` | `toFoldMonoid` | `[O: Identity](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `O` | Sends STDOUT through the stream and folds the result using its _monoid_ instance -| `>?` | `toVector` | `ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `Vector[O]` | Sends STDOUT through the stream and collects the results | -| | `drainOutput` | `ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `Unit` | Drains the STDOUT through the given stream | -| | `foldOutput` | `ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => R` | `R` | Sends STDOUT through the stream and folds the result using a custom fold function | - -All the variants that accept a _stream transformation_ (`ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])`) are also usable by directly passing -a `ZPipeline`. - -`TransformAndSink` encapsulates a _stream transformation_ and a _unit sink_. It is possible to use a sink directly if transformation is not needed. - -```scala -case class TransformAndSink[A, B](transform: ZStream[Any, ProxError, A] => ZStream[Any, ProxError, B], - sink: ZSink[Any, ProxError, B, Any, Unit]) -``` - -### Error redirection -Error redirection is enabled by the `RedirectableError` trait. -The following operations are supported: - -| operator | alternative | parameter type | result type | what it does | -|-----------|---------------------|--------------------------------------------------------------------------------|-------------| --------------| -| `!>` | `errorToFile` | `java.nio.file.Path` | `Unit` | Natively attach STDERR to a file | -| `!>>` | `appendErrorToFile` | `java.nio.file.Path` | `Unit` | Natively attach STDERR to a file in append mode | -| `!>` | `errorToSink` | `TransformAndSink[Byte, _]` | `Unit` | Drains the STDERR through the given sink | -| `!>#` | `errorToFoldMonoid` | `[O: Monoid](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `O` | Sends STDERR through the pipe and folds the result using its _monoid_ instance -| `!>?` | `errorToVector` | `ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `Vector[O]` | Sends STDERR through the pipe and collects the results | -| | `drainError` | `ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `Unit` | Drains the STDERR through the given pipe | -| | `foldError` | `ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => R` | `R` | Sends STDERR through the pipe and folds the result using a custom fold function | - -### Redirection for process groups -[Process groups](processgroups) are two or more processes attached together through pipes. -This connection is internally implemented using the above described redirection capabilities. -This means that all but the first process has their _inputs_ bound, and all but the last one has -their _outputs_ bound. Redirection of input and output for a _process group_ is thus a well defined -operation meaning redirection of input of the _first_ process and redirection of output of the _last process_. - -For this reason the class created via _process piping_ implements the `RedirectableInput` and -`RedirectableOutput` traits described above. - -For the sake of simplicity the library does not support anymore the fully customizable -per-process error redirection for process groups, but a reduced but still quite expressive -version described by the `RedirectableErrors` trait. - -The methods in this trait define error redirection for **all process in the group at once**: - -| operator | alternative | parameter type | result type | what it does | -|-----------|----------------------|--------------------------------------------------------------------------------|-------------| --------------| -| `!>` | `errorsToSink` | `TransformAndSink[Byte, _]` | `Unit` | Drains the STDERR through the given sink | -| `!>#` | `errorsToFoldMonoid` | `[O: Monoid](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `O` | Sends STDERR through the stream and folds the result using its _monoid_ instance -| `!>?` | `errorsToVector` | `ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `Vector[O]` | Sends STDERR through the stream and collects the results | -| | `drainErrors` | `ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `Unit` | Drains the STDERR through the given stream | -| | `foldErrors` | `ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => R` | `R` | Sends STDERR through the stream and folds the result using a custom fold function | - -Redirection to file is not possible through this interface as only a single path could be -provided. -The result of these redirections is accessible through the `ProcessGroupResult` interface as -it is described in the [running processes section](running). - -By using the `RedirectableErrors.customizedPerProcess` interface (having the type -`RedirectableErrors.CustomizedPerProcess`) it is possible to customize the redirection -targets per process while keeping their types uniform: - -| operator | alternative | parameter type | result type | what it does | -|-----------|----------------------|-------------------------------------------------------------------------------------------|-------------| --------------| -| | `errorsToFile` | `Process => java.nio.file.Path` | `Unit` | Natively attach STDERR to a file | -| | `appendErrorsToFile` | `Process => java.nio.file.Path` | `Unit` | Natively attach STDERR to a file in append mode | -| | `errorsToSink` | `Process => TransformAndSink[Byte, _]` | `Unit` | Drains the STDERR through the given sink | -| | `errorsToFoldMonoid` | `Process => [O: Monoid](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `O` | Sends STDERR through the stream and folds the result using its _monoid_ instance -| | `errorsToVector` | `Process => ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `Vector[O]` | Sends STDERR through the stream and collects the results | -| | `drainErrors` | `Process => ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])` | `Unit` | Drains the STDERR through the given stream | -| | `foldErrors` | `Process => ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => R` | `R` | Sends STDERR through the stream and folds the result using a custom fold function | - -Let's see an example of how this works! - -First we define a queue where we want to send _error lines_ from all the involved -processes, then we define the two processes separately, connect them with a pipe and -customize the error redirection where we prefix the parsed lines based on which -process they came from: - - -```scala mdoc:silent - -for { - errors <- Queue.unbounded[String] - parseLines = (s: ZStream[Any, ProxError, Byte]) => s.via(ZPipeline.utf8Decode.mapError(UnknownProxError.apply) >>> ZPipeline.splitLines) - - p1 = Process("proc1") - p2 = Process("proc2") - group = (p1 | p2).customizedPerProcess.errorsToSink { - case p if p == p1 => TransformAndSink(parseLines.andThen(_.map(s => "P1: " + s)), ZSink.foreach(errors.offer)) - case p if p == p2 => TransformAndSink(parseLines.andThen(_.map(s => "P2: " + s)), ZSink.foreach(errors.offer)) - } -} yield () -``` - -### Creating reusable functions -The `Process` object contains several useful _type aliases_ for writing functions that work with any process by -only specifying what redirection channels we want _unbounded_. - -The `UnboundProcess` represents a process which is fully unbound, no redirection has been done yet. It is -defined as follows: - -```scala -type UnboundProcess = Process[Unit, Unit] - with RedirectableInput[UnboundOEProcess] - with RedirectableOutput[UnboundIEProcess[*]] - with RedirectableError[UnboundIOProcess[*]] -``` - -where `UnboundIOProcess[E]` for example represents a process which has its _error output_ already bound. - -These type aliases can be used to define functions performing redirection on arbitrary processes, for example: - -```scala mdoc -def logErrors[P <: Process.UnboundEProcess[_]](proc: P) = { - val target = TransformAndSink( - ZPipeline.utf8Decode.mapError(UnknownProxError.apply) >>> ZPipeline.splitLines, - ZSink.foreach((line: String) => ZIO.debug(line))) - proc !> target -} - -val proc4 = logErrors(Process("something")) -``` \ No newline at end of file diff --git a/docs/docs/docs/zstream/running.md b/docs/docs/docs/zstream/running.md deleted file mode 100644 index a2aa7a78..00000000 --- a/docs/docs/docs/zstream/running.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -layout: docs -title: Running processes ---- - -# Running processes and process groups -```scala mdoc:invisible -import zio._ -import io.github.vigoo.prox._ -import io.github.vigoo.prox.zstream._ -``` - -There are three methods for running a _process_: - -- The `run` method is the simplest one, it starts the process and then blocks the current fiber until it terminates -- The `start` method starts the process and returns a fiber packed into a resource. The fiber finishes when the process terminates. Canceling the fiber terminates the process. -- The `startProcess` method returns a `RunningProcess[O, E]` interface that allows advanced some operations - -Similarly for a _process group_, there is a `run`, a `start` and a `startProcessGroup` method but with different result types. - -Let's see some examples! - -```scala mdoc:silent -implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner - -val process = Process("echo", List("hello")) - -val result1 = process.run() -val result2 = ZIO.scoped { - process.start().flatMap { fiber => - fiber.join - } -} - -val result3 = - for { - runningProcess <- process.startProcess() - _ <- runningProcess.kill() - } yield () -``` - -Both `RunningProcess` and `RunningProcessGroup` has the following methods: -- `waitForExit()` waits until the process terminates -- `terminate()` sends `SIGTERM` to the process -- `kill()` sends `SIGKILL` to the process - -In addition `RunningProcess` also defines an `isAlive` check. - -### Process execution result -The result of a process is represented by `ProcessResult[O, E]` defined as follows: - -```scala -trait ProcessResult[+O, +E] { - val exitCode: ExitCode - val output: O - val error: E -} -``` - -The type and value of `output` and `error` depends on what [redirection was defined](redirection) on the process. - -### Process group execution result -The result of a process group is represented by `ProcessGroupResult[O, E]`: - -```scala -trait ProcessGroupResult[+O, +E] { - val exitCodes: Map[Process[Unit, Unit], ExitCode] - val output: O - val errors: Map[Process[Unit, Unit], E] -} -``` - -The keys of the maps are the original _process_ values used in the piping operations. \ No newline at end of file diff --git a/docs/docs/index.md b/docs/docs/index.md deleted file mode 100644 index d62d8a44..00000000 --- a/docs/docs/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -layout: homeFeatures -title: "prox: Home" -features: - - first: ["Type safe", "Define the execution of one or more system processes in a type safe way"] - - second: ["Purely functional", "Compose the process execution as an IO effect"] - - third: ["Streaming", "Redirect input, output and error to/from functional streams"] ---- - -Prox is a Scala library for running system processes, plugging them to each other and redirecting them to streams. diff --git a/docs/fs2/custom-runners.html b/docs/fs2/custom-runners.html new file mode 100644 index 00000000..d8bd7104 --- /dev/null +++ b/docs/fs2/custom-runners.html @@ -0,0 +1,93 @@ +prox: Custom runners

          Customizing the runner

          + +

          The runner is responsible for stating the native processes and wiring all the redirections together. The default +implementation is called JVMProcessRunner.

          + +

          There are use cases when providing a custom runner makes sense. One such use case could be to launch external processes +within a docker container in case of running on a development machine (for example from tests), while running them directly +in production, when the whole service is running within the container.

          + +

          We can implement this scenario by using JVMProcessRunner in production and a custom DockerizedProcessRunner in tests, +where we define the latter as follows:

          + +
          import java.nio.file.Path
+import java.util.UUID
+
+case class DockerImage(name: String)
+
+case class DockerContainer(name: String)
+
+case class DockerProcessInfo[DockerProcessInfo](container: DockerContainer, dockerProcessInfo: DockerProcessInfo)
+
+class DockerizedProcessRunner[Info](processRunner: ProcessRunner[Info],
+                                    mountedDirectory: Path,
+                                    workingDirectory: Path,
+                                    image: DockerImage)
+  extends ProcessRunner[DockerProcessInfo[Info]] {
+
+  override def startProcess[O, E](process: Process[O, E]): IO[RunningProcess[O, E, DockerProcessInfo[Info]]] = {
+    for { 
+      container <- generateContainerName
+      runningProcess <- processRunner
+        .startProcess(wrapInDocker(process, container))
+    } yield runningProcess.mapInfo(info => DockerProcessInfo(container, info))
+  }
+
+  override def startProcessGroup[O, E](processGroup: ProcessGroup[O, E]): IO[RunningProcessGroup[O, E, DockerProcessInfo[Info]]] = {
+    Traverse[Vector].sequence(processGroup.originalProcesses.toVector.map(key => generateContainerName.map(c => key -> c))).flatMap { keyAndNames =>
+      val nameMap = keyAndNames.toMap 
+      val names = keyAndNames.map(_._2)
+      val modifiedProcessGroup = processGroup.map(new ProcessGroup.Mapper[O, E] {
+        def mapFirst[P <: Process[fs2.Stream[IO, Byte], E]](process: P): P = wrapInDocker(process, names.head).asInstanceOf[P]
+        def mapInnerWithIdx[P <: Process.UnboundIProcess[fs2.Stream[IO, Byte], E]](process: P, idx: Int): P = 
+          wrapInDocker(process, names(idx)).asInstanceOf[P]
+        def mapLast[P <: Process.UnboundIProcess[O, E]](process: P): P = wrapInDocker(process, names.last).asInstanceOf[P]
+      })
+      processRunner.startProcessGroup(modifiedProcessGroup)
+          .map(_.mapInfo { case (key, info) => DockerProcessInfo(nameMap(key), info) })
+    }
+  }
+
+  private def generateContainerName: IO[DockerContainer] =
+    IO(DockerContainer(UUID.randomUUID().toString))
+
+  private def wrapInDocker[O, E](process: Process[O, E], container: DockerContainer): Process[O, E] = {
+    val envVars = process.environmentVariables.flatMap { case (key, value) => List("-e", s"$key=$value") }.toList
+    process.withCommand("docker").withArguments(
+      "run" :: 
+        "--name" :: container.name ::
+        "-v" :: mountedDirectory.toString :: 
+        "-w" :: workingDirectory.toString :: 
+        envVars ::: 
+        List(image.name, process.command) ::: 
+        process.arguments
+    )
+  }
+}
+
          +
          \ No newline at end of file diff --git a/docs/fs2/customize.html b/docs/fs2/customize.html new file mode 100644 index 00000000..e2a6b2f7 --- /dev/null +++ b/docs/fs2/customize.html @@ -0,0 +1,225 @@ +prox: Customizing environment

          Customizing the environment

          + +

          The type returned by the Process constructor also implements the ProcessConfiguration trait, +adding three methods that can be used to customize the working environment of the process to be started:

          + +

          Working directory

          + +

          The in method can be used to customize the working directory:

          + +
          import io.github.vigoo.prox.path._
+
+val dir = home / "tmp"
+// dir: java.nio.file.Path = /home/runner/tmp
+val proc1 = Process("ls") in dir 
+// proc1: Process.ProcessImpl = ProcessImpl(
+//   command = "ls",
+//   arguments = List(),
+//   workingDirectory = Some(value = /home/runner/tmp),
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@2eb4bf64,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@497fbb3f,
+//   inputRedirection = StdIn()
+// )
+
          + +

          Not that dir has the type java.nio.file.Path, and the home / tmp syntax is just a thin +syntax extension to produce such values.

          + +

          Adding environment variables

          + +

          The with method can be used to add environment variables to the process in the following +way:

          + +
          val proc2 = Process("echo", List("$TEST")) `with` ("TEST" -> "Hello world")
+// proc2: Process.ProcessImpl = ProcessImpl(
+//   command = "echo",
+//   arguments = List("$TEST"),
+//   workingDirectory = None,
+//   environmentVariables = Map("TEST" -> "Hello world"),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@5171baaf,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1d4e323c,
+//   inputRedirection = StdIn()
+// )
+
          + +

          Removing environment variables

          + +

          The subprocess inherits the parent process environment, so it may be necessary to +remove some already defined environment variables with the without method:

          + +
          val proc3 = Process("echo" , List("$PATH")) `without` "PATH"
+// proc3: Process.ProcessImpl = ProcessImpl(
+//   command = "echo",
+//   arguments = List("$PATH"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set("PATH"),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@7cbb3028,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3e7b00a1,
+//   inputRedirection = StdIn()
+// )
+
          + +

          Writing reusable functions

          + +

          Because these methods are part of the ProcessConfiguration capability, writing reusable functions require us to define +a polymorphic function that requires this capability:

          + +
          import java.nio.file.Path
+
+def withHome[P <: ProcessLike with ProcessLikeConfiguration](home: Path, proc: P): P#Self = 
+  proc `with` ("HOME" -> home.toString)
+
          + +

          Then we can use it on any kind of process or process group (read about redirection to understand +why there are multiple concrete process types):

          + +
          val proc4 = Process("echo", List("$HOME"))
+// proc4: Process.ProcessImpl = ProcessImpl(
+//   command = "echo",
+//   arguments = List("$HOME"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@62037103,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@e3070ad,
+//   inputRedirection = StdIn()
+// )
+val proc5 = withHome(home, proc4)
+// proc5: Process.ProcessImpl#Self = ProcessImpl(
+//   command = "echo",
+//   arguments = List("$HOME"),
+//   workingDirectory = None,
+//   environmentVariables = Map("HOME" -> "/home/runner"),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@62037103,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@e3070ad,
+//   inputRedirection = StdIn()
+// )
+
+val group1 = Process("grep", List("ERROR")) | Process("sort")
+// group1: ProcessGroup.ProcessGroupImpl = ProcessGroupImpl(
+//   firstProcess = ProcessImplO(
+//     command = "grep",
+//     arguments = List("ERROR"),
+//     workingDirectory = None,
+//     environmentVariables = Map(),
+//     removedEnvironmentVariables = Set(),
+//     outputRedirection = OutputStreamThroughPipe(
+//       pipe = io.github.vigoo.prox.ProxFS2$$Lambda$10722/0x00000008026f6840@2baf2b33,
+//       runner = io.github.vigoo.prox.SyntaxModule$ProcessPiping$$Lambda$10723/0x00000008026f4840@4db758ef,
+//       chunkSize = 8192
+//     ),
+//     runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@3445b333,
+//     errorRedirection = StdOut(),
+//     runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@39fd180e,
+//     inputRedirection = StdIn()
+//   ),
+//   innerProcesses = List(),
+//   lastProcess = ProcessImpl(
+//     command = "sort",
+//     arguments = List(),
+//     workingDirectory = None,
+//     environmentVariables = Map(),
+//     removedEnvironmentVariables = Set(),
+//     outputRedirection = StdOut(),
+//     runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6b595ab1,
+//     errorRedirection = StdOut(),
+//     runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1cde0715,
+//     inputRedirection = StdIn()
+//   ),
+//   originalProcesses = List(
+//     ProcessImpl(
+//       command = "sort",
+//       arguments = List(),
+//       workingDirectory = None,
+//       environmentVariables = Map(),
+//       removedEnvironmentVariables = Set(),
+//       outputRedirection = StdOut(),
+//       runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6b595ab1,
+//       errorRedirection = StdOut(),
+//       runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1cde0715,
+// ...
+val group2 = withHome(home, group1)
+// group2: ProcessGroup.ProcessGroupImpl#Self = ProcessGroupImpl(
+//   firstProcess = ProcessImplO(
+//     command = "grep",
+//     arguments = List("ERROR"),
+//     workingDirectory = None,
+//     environmentVariables = Map("HOME" -> "/home/runner"),
+//     removedEnvironmentVariables = Set(),
+//     outputRedirection = OutputStreamThroughPipe(
+//       pipe = io.github.vigoo.prox.ProxFS2$$Lambda$10722/0x00000008026f6840@2baf2b33,
+//       runner = io.github.vigoo.prox.SyntaxModule$ProcessPiping$$Lambda$10723/0x00000008026f4840@4db758ef,
+//       chunkSize = 8192
+//     ),
+//     runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@3445b333,
+//     errorRedirection = StdOut(),
+//     runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@39fd180e,
+//     inputRedirection = StdIn()
+//   ),
+//   innerProcesses = List(),
+//   lastProcess = ProcessImpl(
+//     command = "sort",
+//     arguments = List(),
+//     workingDirectory = None,
+//     environmentVariables = Map("HOME" -> "/home/runner"),
+//     removedEnvironmentVariables = Set(),
+//     outputRedirection = StdOut(),
+//     runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6b595ab1,
+//     errorRedirection = StdOut(),
+//     runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1cde0715,
+//     inputRedirection = StdIn()
+//   ),
+//   originalProcesses = List(
+//     ProcessImpl(
+//       command = "sort",
+//       arguments = List(),
+//       workingDirectory = None,
+//       environmentVariables = Map(),
+//       removedEnvironmentVariables = Set(),
+//       outputRedirection = StdOut(),
+//       runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6b595ab1,
+//       errorRedirection = StdOut(),
+//       runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1cde0715,
+// ...
+
          +
          \ No newline at end of file diff --git a/docs/fs2/index.html b/docs/fs2/index.html new file mode 100644 index 00000000..ea96dbbb --- /dev/null +++ b/docs/fs2/index.html @@ -0,0 +1,129 @@ +prox: Getting started

          Getting started with prox

          + +

          First add one of the prox interfaces as a dependency:

          + +
          libraryDependencies += "io.github.vigoo" %% "prox-fs2" % "0.7.3"
+
          + +

          or for Cats Effect 3.x / FS2 3.x:

          + +
          libraryDependencies += "io.github.vigoo" %% "prox-fs2-3" % "0.7.3"
+
          + +

          and, assuming that we have a long living Blocker thread pool defined already, we can create +the Prox module:

          + +
          val prox = ProxFS2[IO]
+// prox: ProxFS2[IO] = io.github.vigoo.prox.ProxFS2$$anon$1@3a0166d9
+import prox._
+
          + +

          We require F to implement the Concurrent type class, and for that we have to have an implicit +context shifter in scope (this should be already available in an application using cats-effect).

          + +

          Defining a process to run

          +

          In prox a process to be executed is defined by a pure value which implements the Process[O, E] trait. +The type parameters have the following meaning:

          + +
            +
          • O is the type of the output value after the system process has finished running
            • +
          • E is the type of the error output value after the system process has finished running
            • +
          + +

          To create a simple process to be executed use the Process constructor:

          + +
          val proc1 = Process("ls", List("-hal"))
+// proc1: Process.ProcessImpl = ProcessImpl(
+//   command = "ls",
+//   arguments = List("-hal"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@2bbb290f,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@6e7a64eb,
+//   inputRedirection = StdIn()
+// )
+
          + +

          or we can use the string interpolator:

          + +
          val proc2 = proc"ls -hal"
+// proc2: Process.ProcessImpl = ProcessImpl(
+//   command = "ls",
+//   arguments = List("-hal"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6fecc06b,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@5eea44e1,
+//   inputRedirection = StdIn()
+// )
+
          + +

          Then we can

          + + +

          still staying on purely specification level.

          + +

          Running the process

          + +

          Once we have our process specification ready, we can start the process with one of the +IO functions on process.

          + +

          But for this we first have to have a ProcessRunner implementation in scope. The default +one is called JVMProcessRunner and it can be created in the following way:

          + +
          implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner 
+
          + +

          Read the custom process runners page for an example of using a customized runner.

          + +

          With the runner in place we can use several methods to start the process. +The simplest one is called run and it blocks the active thread until the process finishes +running:

          + +
          proc1.run()
+// res0: ProxIO[ProcessResult[Unit, Unit]] = Uncancelable(
+//   body = cats.effect.IO$$$Lambda$10820/0x000000080309a840@2c6bfd62,
+//   event = cats.effect.tracing.TracingEvent$StackTrace
+// )
+
          + +

          The result of this IO action is a ProcessResult[O, E], with the ability to observe the +exit code and the redirected output and error values. In our first example both O and +E were Unit because the default is to redirect output and error to the standard output and +standard error streams.

          +
          \ No newline at end of file diff --git a/docs/fs2/processgroups.html b/docs/fs2/processgroups.html new file mode 100644 index 00000000..7f24f218 --- /dev/null +++ b/docs/fs2/processgroups.html @@ -0,0 +1,95 @@ +prox: Process groups
          + +
          +
          +
          + +
          +

          Connecting processes together via pipes

          + +

          Connecting one process to another means that the standard output of the first process +gets redirected to the standard input of the second process. This is implemented using +the redirection capabilities described on the redirection page. The result +of connecting one process to another is called a process group and it implements the +trait ProcessGroup[O, E].

          + +

          To create a process group, either:

          +
            +
          • Use the | or via methods between two unbounded processes
            • +
          • Use the | or via methods between an unbounded process group and an unbounded process
            • +
          + +

          It is important that the process group construction must always happen before any redirection, +the type system enforces this by requiring the involved processes to be UnboundedProcess.

          + +
          +

          :bulb: Process.UnboundedProcess is a type alias for a process with all the redirection capabilities

          +
          + +

          Let’s see an example of simply piping:

          + +
          val group1 = Process("grep", List("ERROR")) | Process("sort")
+val group2 = group1 | Process("uniq", List("-c"))
+
          + +

          A custom pipe (when using via) can be anything of the type Pipe[F, Byte, Byte]. The +following not very useful example capitalizes each word coming through:

          + +
          val customPipe: fs2.Pipe[IO, Byte, Byte] =
+    (s: fs2.Stream[IO, Byte]) => s
+      .through(fs2.text.utf8.decode) // decode UTF-8
+      .through(fs2.text.lines)      // split to lines
+      .map(_.split(' ').toVector)   // split lines to words
+      .map(v => v.map(_.capitalize).mkString(" "))
+      .intersperse("\n")            // remerge lines 
+      .through(fs2.text.utf8.encode) // encode as UTF-8
+
+val group3 = Process("echo", List("hello world")).via(customPipe).to(Process("wc", List("-w")))
+
          +
          +
          +
          \ No newline at end of file diff --git a/docs/fs2/redirection.html b/docs/fs2/redirection.html new file mode 100644 index 00000000..cb890ed9 --- /dev/null +++ b/docs/fs2/redirection.html @@ -0,0 +1,456 @@ +prox: Redirection

          Redirecting input, output and error

          + +

          Similarly to customization, redirection is also implemented with capability traits. +The ProcessIO type returned by the Process constructor implements all the three redirection capability +traits:

          + +
            +
          • RedirectableInput marks that the standard input of the process is not bound yet
            • +
          • RedirectableOutput marks that the standard output of the process is not bound yet
            • +
          • RedirectableError marks that the standard error output of the process is not bound yet
            • +
          + +

          Each of the three channels can be only redirected once. The result type of each redirection method no longer +implements the given capability.

          + +

          Let’s see an example of this (redirection methods are described below on this page):

          + +
          import cats.implicits._
+
+val proc1 = Process("echo", List("Hello world"))
+// proc1: Process.ProcessImpl = ProcessImpl(
+//   command = "echo",
+//   arguments = List("Hello world"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@3c441db9,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@646dcd02,
+//   inputRedirection = StdIn()
+// )
+val proc2 = proc1 ># fs2.text.utf8.decode
+// proc2: Process.ProcessImplO[String] = ProcessImplO(
+//   command = "echo",
+//   arguments = List("Hello world"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = OutputStreamThroughPipe(
+//     pipe = fs2.text$utf8$$$Lambda$10896/0x0000000803101040@2ef6a566,
+//     runner = io.github.vigoo.prox.RedirectionModule$RedirectableOutput$$Lambda$10898/0x0000000803107040@13e21eb2,
+//     chunkSize = 8192
+//   ),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@f5760a2,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@646dcd02,
+//   inputRedirection = StdIn()
+// )
+
          + +

          It is no longer possible to redirect the output of proc2:

          + +
          val proc3 = proc2 >? fs2.text.utf8.decode[IO].andThen(fs2.text.lines) 
+// error: value >? is not a member of repl.MdocSession.MdocApp.prox.Process.ProcessImplO[String]
+// did you mean !>??
+// val proc3 = proc2 >? fs2.text.utf8.decode[IO].andThen(fs2.text.lines) 
+//             ^^^^^^^^
+
          + +

          Many redirection methods have an operator version but all of them have alphanumberic +variants as well.

          + +

          Input redirection

          +

          Input redirection is enabled by the RedirectableInput trait. The following operations +are supported:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typewhat it does
          <fromFilejava.nio.file.PathNatively attach a source file to STDIN
          <fromStreamStream[F, Byte]Attach an fs2 byte stream to STDIN
          !<fromStreamStream[F, Byte]Attach an fs2 byte stream to STDIN and flush after each chunk
          + +

          Output redirection

          +

          Output redirection is enabled by the RedirectableOutput trait. +The following operations are supported:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typeresult typewhat it does
          >toFilejava.nio.file.PathUnitNatively attach STDOUT to a file
          >>appendToFilejava.nio.file.PathUnitNatively attach STDOUT to a file in append mode
          >toSinkPipe[F, Byte, Unit]UnitDrains the STDOUT through the given pipe
          >#toFoldMonoid[O: Monoid](Pipe[F, Byte, O]OSends STDOUT through the pipe and folds the result using its monoid instance
          >?toVectorPipe[F, Byte, O]Vector[O]Sends STDOUT through the pipe and collects the results
           drainOutputPipe[F, Byte, O]UnitDrains the STDOUT through the given pipe
           foldOutputPipe[F, Byte, O], R, (R, O) => RRSends STDOUT through the pipe and folds the result using a custom fold function
          + +

          Error redirection

          +

          Error redirection is enabled by the RedirectableError trait. +The following operations are supported:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typeresult typewhat it does
          !>errorToFilejava.nio.file.PathUnitNatively attach STDERR to a file
          !>>appendErrorToFilejava.nio.file.PathUnitNatively attach STDERR to a file in append mode
          !>errorToSinkPipe[F, Byte, Unit]UnitDrains the STDERR through the given pipe
          !>#errorToFoldMonoid[O: Monoid](Pipe[F, Byte, O]OSends STDERR through the pipe and folds the result using its monoid instance
          !>?errorToVectorPipe[F, Byte, O]Vector[O]Sends STDERR through the pipe and collects the results
           drainErrorPipe[F, Byte, O]UnitDrains the STDERR through the given pipe
           foldErrorPipe[F, Byte, O], R, (R, O) => RRSends STDERR through the pipe and folds the result using a custom fold function
          + +

          Redirection for process groups

          +

          Process groups are two or more processes attached together through pipes. +This connection is internally implemented using the above described redirection capabilities. +This means that all but the first process has their inputs bound, and all but the last one has +their outputs bound. Redirection of input and output for a process group is thus a well defined +operation meaning redirection of input of the first process and redirection of output of the last process.

          + +

          For this reason the class created via process piping implements the RedirectableInput and +RedirectableOutput traits described above.

          + +

          For the sake of simplicity the library does not support anymore the fully customizable +per-process error redirection for process groups, but a reduced but still quite expressive +version described by the RedirectableErrors trait.

          + +

          The methods in this trait define error redirection for all process in the group at once:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typeresult typewhat it does
          !>errorsToSinkPipe[F, Byte, Unit]UnitDrains the STDERR through the given pipe
          !>#errorsToFoldMonoid[O: Monoid](Pipe[F, Byte, O]OSends STDERR through the pipe and folds the result using its monoid instance
          !>?errorsToVectorPipe[F, Byte, O]Vector[O]Sends STDERR through the pipe and collects the results
           drainErrorsPipe[F, Byte, O]UnitDrains the STDERR through the given pipe
           foldErrorsPipe[F, Byte, O], R, (R, O) => RRSends STDERR through the pipe and folds the result using a custom fold function
          + +

          Redirection to file is not possible through this interface as only a single path could be +provided. +The result of these redirections is accessible through the ProcessGroupResult interface as +it is described in the running processes section.

          + +

          By using the RedirectableErrors.customizedPerProcess interface (having the type +RedirectableErrors.CustomizedPerProcess) it is possible to customize the redirection +targets per process while keeping their types uniform:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typeresult typewhat it does
           errorsToFileProcess => java.nio.file.PathUnitNatively attach STDERR to a file
           appendErrorsToFileProcess => java.nio.file.PathUnitNatively attach STDERR to a file in append mode
           errorsToSinkProcess => Pipe[F, Byte, Unit]UnitDrains the STDERR through the given pipe
           errorsToFoldMonoidProcess => [O: Monoid](Pipe[F, Byte, O]OSends STDERR through the pipe and folds the result using its monoid instance
           errorsToVectorProcess => Pipe[F, Byte, O]Vector[O]Sends STDERR through the pipe and collects the results
           drainErrorsProcess => Pipe[F, Byte, O]UnitDrains the STDERR through the given pipe
           foldErrorsProcess => Pipe[F, Byte, O], R, (R, O) => RRSends STDERR through the pipe and folds the result using a custom fold function
          + +

          Let’s see an example of how this works!

          + +

          First we define a queue where we want to send error lines from all the involved +processes, then we define the two processes separately, connect them with a pipe and +customize the error redirection where we prefix the parsed lines based on which +process they came from:

          + +
          import cats.effect.std.Queue
+
+for {
+  errors <- Queue.unbounded[IO, String]
+  parseLines = fs2.text.utf8.decode[IO].andThen(fs2.text.lines)
+ 
+  p1 = Process("proc1")
+  p2 = Process("proc2")
+  group = (p1 | p2).customizedPerProcess.errorsToSink {
+    case p if p == p1 => parseLines.andThen(_.map(s => "P1: " + s)).andThen(_.evalMap(errors.offer))
+    case p if p == p2 => parseLines.andThen(_.map(s => "P2: " + s)).andThen(_.evalMap(errors.offer))
+  }
+} yield ()
+
          + +

          Creating reusable functions

          +

          The Process object contains several useful type aliases for writing functions that work with any process by +only specifying what redirection channels we want unbounded.

          + +

          The UnboundProcess represents a process which is fully unbound, no redirection has been done yet. It is +defined as follows:

          + +
          type UnboundProcess = Process[Unit, Unit]
+    with RedirectableInput[UnboundOEProcess]
+    with RedirectableOutput[UnboundIEProcess[*]]
+    with RedirectableError[UnboundIOProcess[*]]
+
          + +

          where UnboundIOProcess[E] for example represents a process which has its error output already bound.

          + +

          These type aliases can be used to define functions performing redirection on arbitrary processes, for example:

          + +
          def logErrors[P <: Process.UnboundEProcess[_]](proc: P) = {
+   val target = fs2.text.utf8.decode[IO].andThen(fs2.text.lines).andThen(_.evalMap(line => IO(println(line)))) 
+   proc !> target 
+}
+
+val proc4 = logErrors(Process("something"))
+// proc4: Process[_, Unit] = ProcessImplE(
+//   command = "something",
+//   arguments = List(),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@465296ac,
+//   errorRedirection = OutputStreamToSink(
+//     sink = scala.Function1$$Lambda$10901/0x0000000803105040@4b7024b1,
+//     chunkSize = 8192
+//   ),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10902/0x0000000803103840@effd624,
+//   inputRedirection = StdIn()
+// )
+
          +
          \ No newline at end of file diff --git a/docs/fs2/running.html b/docs/fs2/running.html new file mode 100644 index 00000000..3fe4432f --- /dev/null +++ b/docs/fs2/running.html @@ -0,0 +1,88 @@ +prox: Running processes

          Running processes and process groups

          + +

          There are three methods for running a process:

          + +
            +
          • The run method is the simplest one, it starts the process and then blocks the current fiber until it terminates
            • +
          • The start method starts the process and returns a fiber packed into a resource. The fiber finishes when the process terminates. Canceling the fiber terminates the process.
            • +
          • The startProcess method returns a RunningProcess[O, E] interface that allows advanced some operations
            • +
          + +

          Similarly for a process group, there is a run, a start and a startProcessGroup method but with different result types.

          + +

          Let’s see some examples!

          + +
          implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner 
+
+val process = Process("echo", List("hello"))
+
+val result1 = process.run()
+val result2 = process.start().flatMap { fiber =>
+  fiber.join
+}
+
+val result3 = 
+  for { 
+    runningProcess <- process.startProcess()
+    _ <- runningProcess.kill()
+  } yield ()
+
          + +

          Both RunningProcess and RunningProcessGroup has the following methods:

          +
            +
          • waitForExit() waits until the process terminates
            • +
          • terminate() sends SIGTERM to the process
            • +
          • kill() sends SIGKILL to the process
            • +
          + +

          In addition RunningProcess also defines an isAlive check.

          + +

          Process execution result

          +

          The result of a process is represented by ProcessResult[O, E] defined as follows:

          + +
          trait ProcessResult[+O, +E] {
+  val exitCode: ExitCode
+  val output: O
+  val error: E
+}
+
          + +

          The type and value of output and error depends on what redirection was defined on the process.

          + +

          Process group execution result

          +

          The result of a process group is represented by ProcessGroupResult[O, E]:

          + +
          trait ProcessGroupResult[+O, +E] {
+  val exitCodes: Map[Process[Unit, Unit], ExitCode]
+  val output: O
+  val errors: Map[Process[Unit, Unit], E]
+}
+
          + +

          The keys of the maps are the original process values used in the piping operations.

          +
          \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..99ea5140 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,32 @@ +prox: Getting started \ No newline at end of file diff --git a/docs/migration.html b/docs/migration.html new file mode 100644 index 00000000..8fb4921c --- /dev/null +++ b/docs/migration.html @@ -0,0 +1,65 @@ +prox: Migration

          Migration

          + +

          from 0.1.x to 0.2

          + +
            +
          • The start method on processes now requires a blockingExecutionContext argument
            • +
          • Ignore has been renamed to Drain
            • +
          • Log has been renamed to ToVector
            • +
          + +

          from 0.2 to 0.4

          + +
            +
          • Process now takes the effect type as parameter, so in case of cats-effect, Process(...) becomes Process[IO](...)
            • +
          • The start method on processes now gets a Blocker instead of an execution context
            • +
          + +

          from 0.4 to 0.5

          + +

          0.5 is a complete rewrite of the original library, and the API changed a lot, especially +if the process types were used in code to pass around / wrap them. Please refer to the other +sections of the documentation to learn how to reimplement them. For simple use cases where +constructing and running the processes directly the main differences are:

          + + + +

          from 0.5 to 0.6

          + +

          0.6 introduces the native ZIO/ZStream version of the library. For existing code the following differences apply:

          + +
            +
          • Instead of prox, the artifact is now called prox-fs2
            • +
          • Instead of global imports, the FS2 prox module now has to be constructed with the FS2 constructor and the API is imported from that
            • +
          • Because the FS2 module captures the F[_] and the Blocker, they are no longer needed to pass on to the API functions and types
            • +
          +
          \ No newline at end of file diff --git a/docs/src/microsite/data/menu.yml b/docs/src/microsite/data/menu.yml deleted file mode 100644 index f9429444..00000000 --- a/docs/src/microsite/data/menu.yml +++ /dev/null @@ -1,48 +0,0 @@ -options: - - title: Home - url: index - - title: Cats Effect / FS2 - url: docs/fs2/index.html - menu_section: fs2 - - nested_options: - - title: Getting started - url: docs/fs2/index.html - - title: Customizing environment - url: docs/fs2/customize.html - - title: Redirection - url: docs/fs2/redirection.html - - title: Process groups - url: docs/fs2/processgroups.html - - title: Running processes - url: docs/fs2/running.html - - title: Custom runners - url: docs/fs2/custom-runners.html - - - title: ZIO / ZStream - url: docs/zstream/index.html - menu_section: zstream - - nested_options: - - title: Getting started - url: docs/zstream/index.html - - title: Customizing environment - url: docs/zstream/customize.html - - title: Redirection - url: docs/zstream/redirection.html - - title: Process groups - url: docs/zstream/processgroups.html - - title: Running processes - url: docs/zstream/running.html - - title: Custom runners - url: docs/zstream/custom-runners.html - - - title: Migration - url: docs/migration.html - menu_section: migration - - title: Blog posts - url: docs/blogposts.html - menu_section: blogposts - - title: API reference - url: api/io/github/vigoo/prox/ - menu_section: apireference \ No newline at end of file diff --git a/docs/zstream/custom-runners.html b/docs/zstream/custom-runners.html new file mode 100644 index 00000000..80314ba2 --- /dev/null +++ b/docs/zstream/custom-runners.html @@ -0,0 +1,93 @@ +prox: Custom runners

          Customizing the runner

          + +

          The runner is responsible for stating the native processes and wiring all the redirections together. The default +implementation is called JVMProcessRunner.

          + +

          There are use cases when providing a custom runner makes sense. One such use case could be to launch external processes +within a docker container in case of running on a development machine (for example from tests), while running them directly +in production, when the whole service is running within the container.

          + +

          We can implement this scenario by using JVMProcessRunner in production and a custom DockerizedProcessRunner in tests, +where we define the latter as follows:

          + +
          import java.nio.file.Path
+import java.util.UUID
+
+case class DockerImage(name: String)
+
+case class DockerContainer(name: String)
+
+case class DockerProcessInfo[DockerProcessInfo](container: DockerContainer, dockerProcessInfo: DockerProcessInfo)
+
+class DockerizedProcessRunner[Info](processRunner: ProcessRunner[Info],
+                                    mountedDirectory: Path,
+                                    workingDirectory: Path,
+                                    image: DockerImage)
+  extends ProcessRunner[DockerProcessInfo[Info]] {
+
+  override def startProcess[O, E](process: Process[O, E]): ZIO[Any, ProxError, RunningProcess[O, E, DockerProcessInfo[Info]]] = {
+    for { 
+      container <- generateContainerName
+      runningProcess <- processRunner
+        .startProcess(wrapInDocker(process, container))
+    } yield runningProcess.mapInfo(info => DockerProcessInfo(container, info))
+  }
+
+  override def startProcessGroup[O, E](processGroup: ProcessGroup[O, E]): ZIO[Any, ProxError, RunningProcessGroup[O, E, DockerProcessInfo[Info]]] = {
+    ZIO.foreach(processGroup.originalProcesses.toVector)(key => generateContainerName.map(c => key -> c)).flatMap { keyAndNames =>
+      val nameMap = keyAndNames.toMap 
+      val names = keyAndNames.map(_._2)
+      val modifiedProcessGroup = processGroup.map(new ProcessGroup.Mapper[O, E] {
+        def mapFirst[P <: Process[ZStream[Any, ProxError, Byte], E]](process: P): P = wrapInDocker(process, names.head).asInstanceOf[P]
+        def mapInnerWithIdx[P <: Process.UnboundIProcess[ZStream[Any, ProxError, Byte], E]](process: P, idx: Int): P = 
+          wrapInDocker(process, names(idx)).asInstanceOf[P]
+        def mapLast[P <: Process.UnboundIProcess[O, E]](process: P): P = wrapInDocker(process, names.last).asInstanceOf[P]
+      })
+      processRunner.startProcessGroup(modifiedProcessGroup)
+          .map(_.mapInfo { case (key, info) => DockerProcessInfo(nameMap(key), info) })
+    }
+  }
+
+  private def generateContainerName: ZIO[Any, ProxError, DockerContainer] =
+    ZIO.attempt(DockerContainer(UUID.randomUUID().toString)).mapError(UnknownProxError)
+
+  private def wrapInDocker[O, E](process: Process[O, E], container: DockerContainer): Process[O, E] = {
+    val envVars = process.environmentVariables.flatMap { case (key, value) => List("-e", s"$key=$value") }.toList
+    process.withCommand("docker").withArguments(
+      "run" :: 
+        "--name" :: container.name ::
+        "-v" :: mountedDirectory.toString :: 
+        "-w" :: workingDirectory.toString :: 
+        envVars ::: 
+        List(image.name, process.command) ::: 
+        process.arguments
+    )
+  }
+}
+
          +
          \ No newline at end of file diff --git a/docs/zstream/customize.html b/docs/zstream/customize.html new file mode 100644 index 00000000..b3c935eb --- /dev/null +++ b/docs/zstream/customize.html @@ -0,0 +1,225 @@ +prox: Customizing environment

          Customizing the environment

          + +

          The type returned by the Process constructor also implements the ProcessConfiguration trait, +adding three methods that can be used to customize the working environment of the process to be started:

          + +

          Working directory

          + +

          The in method can be used to customize the working directory:

          + +
          import io.github.vigoo.prox.path._
+
+val dir = home / "tmp"
+// dir: java.nio.file.Path = /home/runner/tmp
+val proc1 = Process("ls") in dir 
+// proc1: Process.ProcessImpl = ProcessImpl(
+//   command = "ls",
+//   arguments = List(),
+//   workingDirectory = Some(value = /home/runner/tmp),
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@68413682,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@21441d72,
+//   inputRedirection = StdIn()
+// )
+
          + +

          Not that dir has the type java.nio.file.Path, and the home / tmp syntax is just a thin +syntax extension to produce such values.

          + +

          Adding environment variables

          + +

          The with method can be used to add environment variables to the process in the following +way:

          + +
          val proc2 = Process("echo", List("$TEST")) `with` ("TEST" -> "Hello world")
+// proc2: Process.ProcessImpl = ProcessImpl(
+//   command = "echo",
+//   arguments = List("$TEST"),
+//   workingDirectory = None,
+//   environmentVariables = Map("TEST" -> "Hello world"),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@3e325af1,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@5bd0336b,
+//   inputRedirection = StdIn()
+// )
+
          + +

          Removing environment variables

          + +

          The subprocess inherits the parent process environment, so it may be necessary to +remove some already defined environment variables with the without method:

          + +
          val proc3 = Process("echo" , List("$PATH")) `without` "PATH"
+// proc3: Process.ProcessImpl = ProcessImpl(
+//   command = "echo",
+//   arguments = List("$PATH"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set("PATH"),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@3a44ebb5,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3b6ace02,
+//   inputRedirection = StdIn()
+// )
+
          + +

          Writing reusable functions

          + +

          Because these methods are part of the ProcessConfiguration capability, writing reusable functions require us to define +a polymorphic function that requires this capability:

          + +
          import java.nio.file.Path
+
+def withHome[P <: ProcessLike with ProcessLikeConfiguration](home: Path, proc: P): P#Self = 
+  proc `with` ("HOME" -> home.toString)
+
          + +

          Then we can use it on any kind of process or process group (read about redirection to understand +why there are multiple concrete process types):

          + +
          val proc4 = Process("echo", List("$HOME"))
+// proc4: Process.ProcessImpl = ProcessImpl(
+//   command = "echo",
+//   arguments = List("$HOME"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@17a3ee4c,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@4d32dcb8,
+//   inputRedirection = StdIn()
+// )
+val proc5 = withHome(home, proc4)
+// proc5: Process.ProcessImpl#Self = ProcessImpl(
+//   command = "echo",
+//   arguments = List("$HOME"),
+//   workingDirectory = None,
+//   environmentVariables = Map("HOME" -> "/home/runner"),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@17a3ee4c,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@4d32dcb8,
+//   inputRedirection = StdIn()
+// )
+
+val group1 = Process("grep", List("ERROR")) | Process("sort")
+// group1: ProcessGroup.ProcessGroupImpl = ProcessGroupImpl(
+//   firstProcess = ProcessImplO(
+//     command = "grep",
+//     arguments = List("ERROR"),
+//     workingDirectory = None,
+//     environmentVariables = Map(),
+//     removedEnvironmentVariables = Set(),
+//     outputRedirection = OutputStreamThroughPipe(
+//       pipe = io.github.vigoo.prox.ProxZStream$$Lambda$10965/0x00000008031b7040@50368fe8,
+//       runner = io.github.vigoo.prox.SyntaxModule$ProcessPiping$$Lambda$10723/0x00000008026f4840@3dc14132,
+//       chunkSize = 8192
+//     ),
+//     runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@35980948,
+//     errorRedirection = StdOut(),
+//     runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@6e94c45f,
+//     inputRedirection = StdIn()
+//   ),
+//   innerProcesses = List(),
+//   lastProcess = ProcessImpl(
+//     command = "sort",
+//     arguments = List(),
+//     workingDirectory = None,
+//     environmentVariables = Map(),
+//     removedEnvironmentVariables = Set(),
+//     outputRedirection = StdOut(),
+//     runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@a395faa,
+//     errorRedirection = StdOut(),
+//     runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3d46470e,
+//     inputRedirection = StdIn()
+//   ),
+//   originalProcesses = List(
+//     ProcessImpl(
+//       command = "sort",
+//       arguments = List(),
+//       workingDirectory = None,
+//       environmentVariables = Map(),
+//       removedEnvironmentVariables = Set(),
+//       outputRedirection = StdOut(),
+//       runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@a395faa,
+//       errorRedirection = StdOut(),
+//       runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3d46470e,
+// ...
+val group2 = withHome(home, group1)
+// group2: ProcessGroup.ProcessGroupImpl#Self = ProcessGroupImpl(
+//   firstProcess = ProcessImplO(
+//     command = "grep",
+//     arguments = List("ERROR"),
+//     workingDirectory = None,
+//     environmentVariables = Map("HOME" -> "/home/runner"),
+//     removedEnvironmentVariables = Set(),
+//     outputRedirection = OutputStreamThroughPipe(
+//       pipe = io.github.vigoo.prox.ProxZStream$$Lambda$10965/0x00000008031b7040@50368fe8,
+//       runner = io.github.vigoo.prox.SyntaxModule$ProcessPiping$$Lambda$10723/0x00000008026f4840@3dc14132,
+//       chunkSize = 8192
+//     ),
+//     runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@35980948,
+//     errorRedirection = StdOut(),
+//     runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@6e94c45f,
+//     inputRedirection = StdIn()
+//   ),
+//   innerProcesses = List(),
+//   lastProcess = ProcessImpl(
+//     command = "sort",
+//     arguments = List(),
+//     workingDirectory = None,
+//     environmentVariables = Map("HOME" -> "/home/runner"),
+//     removedEnvironmentVariables = Set(),
+//     outputRedirection = StdOut(),
+//     runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@a395faa,
+//     errorRedirection = StdOut(),
+//     runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3d46470e,
+//     inputRedirection = StdIn()
+//   ),
+//   originalProcesses = List(
+//     ProcessImpl(
+//       command = "sort",
+//       arguments = List(),
+//       workingDirectory = None,
+//       environmentVariables = Map(),
+//       removedEnvironmentVariables = Set(),
+//       outputRedirection = StdOut(),
+//       runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@a395faa,
+//       errorRedirection = StdOut(),
+//       runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3d46470e,
+// ...
+
          +
          \ No newline at end of file diff --git a/docs/zstream/index.html b/docs/zstream/index.html new file mode 100644 index 00000000..b3e012f4 --- /dev/null +++ b/docs/zstream/index.html @@ -0,0 +1,134 @@ +prox: Getting started

          Getting started with prox

          + +

          First add one of the prox interfaces as a dependency:

          + +
          libraryDependencies += "io.github.vigoo" %% "prox-zstream" % "0.7.3"
+
          + +

          and import the ZIO specific API from:

          + +
          import io.github.vigoo.prox._
+import io.github.vigoo.prox.zstream._
+
          + +

          There is also an experimental version for ZIO 2, based on it’s snapshot releases:

          + +
          libraryDependencies += "io.github.vigoo" %% "prox-zstream-2" % "0.7.3"
+
          + +

          The code snippets in the documentation are based on the ZIO 1 version.

          + +

          Defining a process to run

          +

          In prox a process to be executed is defined by a pure value which implements the Process[O, E] trait. +The type parameters have the following meaning:

          + +
            +
          • O is the type of the output value after the system process has finished running
            • +
          • E is the type of the error output value after the system process has finished running
            • +
          + +

          To create a simple process to be executed use the Process constructor:

          + +
          val proc1 = Process("ls", List("-hal"))
+// proc1: Process.ProcessImpl = ProcessImpl(
+//   command = "ls",
+//   arguments = List("-hal"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@7e0a87d1,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@7ae455b3,
+//   inputRedirection = StdIn()
+// )
+
          + +

          or we can use the string interpolator:

          + +
          val proc2 = proc"ls -hal"
+// proc2: Process.ProcessImpl = ProcessImpl(
+//   command = "ls",
+//   arguments = List("-hal"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@553fef4a,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3db98ccc,
+//   inputRedirection = StdIn()
+// )
+
          + +

          Then we can

          + + +

          still staying on purely specification level.

          + +

          Running the process

          + +

          Once we have our process specification ready, we can start the process with one of the +IO functions on process.

          + +

          But for this we first have to have a ProcessRunner implementation in scope. The default +one is called JVMProcessRunner and it can be created in the following way:

          + +
          implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner 
+
          + +

          Read the custom process runners page for an example of using a customized runner.

          + +

          With the runner in place we can use several methods to start the process. +The simplest one is called run and it blocks the active thread until the process finishes +running:

          + +
          proc1.run()
+// res0: ProxIO[ProcessResult[Unit, Unit]] = OnSuccess(
+//   trace = "io.github.vigoo.prox.ProxZStream.useResource(ProxZStream.scala:117)",
+//   first = OnSuccess(
+//     trace = "io.github.vigoo.prox.ProxZStream.useResource(ProxZStream.scala:117)",
+//     first = Sync(
+//       trace = "io.github.vigoo.prox.ProxZStream.useResource(ProxZStream.scala:117)",
+//       eval = zio.Scope$ReleaseMap$$$Lambda$10957/0x000000080319fc40@1727b0a5
+//     ),
+//     successK = zio.ZIO$$Lambda$10959/0x000000080319e040@4fb6263f
+//   ),
+//   successK = zio.ZIO$ScopedPartiallyApplied$$$Lambda$10960/0x000000080319d040@6559d53c
+// )
+
          + +

          The result of this IO action is a ProcessResult[O, E], with the ability to observe the +exit code and the redirected output and error values. In our first example both O and +E were Unit because the default is to redirect output and error to the standard output and +standard error streams.

          +
          \ No newline at end of file diff --git a/docs/zstream/processgroups.html b/docs/zstream/processgroups.html new file mode 100644 index 00000000..2fc98269 --- /dev/null +++ b/docs/zstream/processgroups.html @@ -0,0 +1,95 @@ +prox: Process groups
          + +
          +
          +
          + +
          +

          Connecting processes together via pipes

          + +

          Connecting one process to another means that the standard output of the first process +gets redirected to the standard input of the second process. This is implemented using +the redirection capabilities described on the redirection page. The result +of connecting one process to another is called a process group and it implements the +trait ProcessGroup[O, E].

          + +

          To create a process group, either:

          +
            +
          • Use the | or via methods between two unbounded processes
            • +
          • Use the | or via methods between an unbounded process group and an unbounded process
            • +
          + +

          It is important that the process group construction must always happen before any redirection, +the type system enforces this by requiring the involved processes to be UnboundedProcess.

          + +
          +

          :bulb: Process.UnboundedProcess is a type alias for a process with all the redirection capabilities

          +
          + +

          Let’s see an example of simply pipeing:

          + +
          val group1 = Process("grep", List("ERROR")) | Process("sort")
+val group2 = group1 | Process("uniq", List("-c"))
+
          + +

          A custom pipe (when using via) can be anything of the type ZStream[any, ProxError, Byte] => ZStream[any, ProxError, Byte]). +The following not very useful example capitalizes each word coming through:

          + +
          val customPipe: ProxPipe[Byte, Byte] =
+    (s: ZStream[Any, ProxError, Byte]) => s
+      .via(ZPipeline.utf8Decode.mapError(UnknownProxError.apply))            // decode UTF-8
+      .via(ZPipeline.splitLines)            // split to lines
+      .map(_.split(' ').toVector)                   // split lines to words
+      .map(v => v.map(_.capitalize).mkString(" "))
+      .intersperse("\n")                            // remerge lines 
+      .flatMap(str => ZStream.fromIterable(str.getBytes(StandardCharsets.UTF_8))) // reencode
+
+val group3 = Process("echo", List("hello world")).via(customPipe).to(Process("wc", List("-w")))
+
          +
          +
          +
          \ No newline at end of file diff --git a/docs/zstream/redirection.html b/docs/zstream/redirection.html new file mode 100644 index 00000000..4bafed59 --- /dev/null +++ b/docs/zstream/redirection.html @@ -0,0 +1,471 @@ +prox: Redirection

          Redirecting input, output and error

          + +

          Similarly to customization, redirection is also implemented with capability traits. +The ProcessIO type returned by the Process constructor implements all the three redirection capability +traits:

          + +
            +
          • RedirectableInput marks that the standard input of the process is not bound yet
            • +
          • RedirectableOutput marks that the standard output of the process is not bound yet
            • +
          • RedirectableError marks that the standard error output of the process is not bound yet
            • +
          + +

          Each of the three channels can be only redirected once. The result type of each redirection method no longer +implements the given capability.

          + +

          Let’s see an example of this (redirection methods are described below on this page):

          + +
          import zio._
+import zio.stream._
+import zio.prelude._
+
+val proc1 = Process("echo", List("Hello world"))
+// proc1: Process.ProcessImpl = ProcessImpl(
+//   command = "echo",
+//   arguments = List("Hello world"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@3281308b,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@65fd9c21,
+//   inputRedirection = StdIn()
+// )
+val proc2 = proc1 ># ZPipeline.utf8Decode
+// proc2: Process.ProcessImplO[String] = ProcessImplO(
+//   command = "echo",
+//   arguments = List("Hello world"),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = OutputStreamThroughPipe(
+//     pipe = io.github.vigoo.prox.ProxZStream$$Lambda$10979/0x00000008031db840@30088784,
+//     runner = io.github.vigoo.prox.RedirectionModule$RedirectableOutput$$Lambda$10898/0x0000000803107040@202f727d,
+//     chunkSize = 8192
+//   ),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@1b110b9b,
+//   errorRedirection = StdOut(),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@65fd9c21,
+//   inputRedirection = StdIn()
+// )
+
          + +

          It is no longer possible to redirect the output of proc2:

          + +
          val proc3 = proc2 >? (ZPipeline.utf8Decode >>> ZPipeline.splitLines) 
+// error: value >? is not a member of io.github.vigoo.prox.zstream.Process.ProcessImplO[String]
+// did you mean !>??
+// val proc3 = proc2 >? (ZPipeline.utf8Decode >>> ZPipeline.splitLines) 
+//             ^^^^^^^^
+
          + +

          Many redirection methods have an operator version but all of them have alphanumberic +variants as well.

          + +

          Input redirection

          +

          Input redirection is enabled by the RedirectableInput trait. The following operations +are supported:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typewhat it does
          <fromFilejava.nio.file.PathNatively attach a source file to STDIN
          <fromStreamZStream[Any, ProxError, Byte]Attach a ZIO byte stream to STDIN
          !<fromStreamZStream[Any, ProxError, Byte]Attach a ZIO byte stream to STDIN and flush after each chunk
          + +

          Output redirection

          +

          Output redirection is enabled by the RedirectableOutput trait. +The following operations are supported:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typeresult typewhat it does
          >toFilejava.nio.file.PathUnitNatively attach STDOUT to a file
          >>appendToFilejava.nio.file.PathUnitNatively attach STDOUT to a file in append mode
          >toSinkTransformAndSink[Byte, _]UnitDrains the STDOUT through the given sink
          >#toFoldMonoid[O: Identity](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])OSends STDOUT through the stream and folds the result using its monoid instance
          >?toVectorZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])Vector[O]Sends STDOUT through the stream and collects the results
           drainOutputZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])UnitDrains the STDOUT through the given stream
           foldOutputZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => RRSends STDOUT through the stream and folds the result using a custom fold function
          + +

          All the variants that accept a stream transformation (ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])) are also usable by directly passing +a ZPipeline.

          + +

          TransformAndSink encapsulates a stream transformation and a unit sink. It is possible to use a sink directly if transformation is not needed.

          + +
          case class TransformAndSink[A, B](transform: ZStream[Any, ProxError, A] => ZStream[Any, ProxError, B],
+                                  sink: ZSink[Any, ProxError, B, Any, Unit])
+
          + +

          Error redirection

          +

          Error redirection is enabled by the RedirectableError trait. +The following operations are supported:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typeresult typewhat it does
          !>errorToFilejava.nio.file.PathUnitNatively attach STDERR to a file
          !>>appendErrorToFilejava.nio.file.PathUnitNatively attach STDERR to a file in append mode
          !>errorToSinkTransformAndSink[Byte, _]UnitDrains the STDERR through the given sink
          !>#errorToFoldMonoid[O: Monoid](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])OSends STDERR through the pipe and folds the result using its monoid instance
          !>?errorToVectorZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])Vector[O]Sends STDERR through the pipe and collects the results
           drainErrorZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])UnitDrains the STDERR through the given pipe
           foldErrorZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => RRSends STDERR through the pipe and folds the result using a custom fold function
          + +

          Redirection for process groups

          +

          Process groups are two or more processes attached together through pipes. +This connection is internally implemented using the above described redirection capabilities. +This means that all but the first process has their inputs bound, and all but the last one has +their outputs bound. Redirection of input and output for a process group is thus a well defined +operation meaning redirection of input of the first process and redirection of output of the last process.

          + +

          For this reason the class created via process piping implements the RedirectableInput and +RedirectableOutput traits described above.

          + +

          For the sake of simplicity the library does not support anymore the fully customizable +per-process error redirection for process groups, but a reduced but still quite expressive +version described by the RedirectableErrors trait.

          + +

          The methods in this trait define error redirection for all process in the group at once:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typeresult typewhat it does
          !>errorsToSinkTransformAndSink[Byte, _]UnitDrains the STDERR through the given sink
          !>#errorsToFoldMonoid[O: Monoid](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])OSends STDERR through the stream and folds the result using its monoid instance
          !>?errorsToVectorZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])Vector[O]Sends STDERR through the stream and collects the results
           drainErrorsZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])UnitDrains the STDERR through the given stream
           foldErrorsZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => RRSends STDERR through the stream and folds the result using a custom fold function
          + +

          Redirection to file is not possible through this interface as only a single path could be +provided. +The result of these redirections is accessible through the ProcessGroupResult interface as +it is described in the running processes section.

          + +

          By using the RedirectableErrors.customizedPerProcess interface (having the type +RedirectableErrors.CustomizedPerProcess) it is possible to customize the redirection +targets per process while keeping their types uniform:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          operatoralternativeparameter typeresult typewhat it does
           errorsToFileProcess => java.nio.file.PathUnitNatively attach STDERR to a file
           appendErrorsToFileProcess => java.nio.file.PathUnitNatively attach STDERR to a file in append mode
           errorsToSinkProcess => TransformAndSink[Byte, _]UnitDrains the STDERR through the given sink
           errorsToFoldMonoidProcess => [O: Monoid](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])OSends STDERR through the stream and folds the result using its monoid instance
           errorsToVectorProcess => ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])Vector[O]Sends STDERR through the stream and collects the results
           drainErrorsProcess => ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])UnitDrains the STDERR through the given stream
           foldErrorsProcess => ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => RRSends STDERR through the stream and folds the result using a custom fold function
          + +

          Let’s see an example of how this works!

          + +

          First we define a queue where we want to send error lines from all the involved +processes, then we define the two processes separately, connect them with a pipe and +customize the error redirection where we prefix the parsed lines based on which +process they came from:

          + +
          
+for {
+  errors <- Queue.unbounded[String]
+  parseLines = (s: ZStream[Any, ProxError, Byte]) => s.via(ZPipeline.utf8Decode.mapError(UnknownProxError.apply) >>> ZPipeline.splitLines)
+ 
+  p1 = Process("proc1")
+  p2 = Process("proc2")
+  group = (p1 | p2).customizedPerProcess.errorsToSink {
+    case p if p == p1 => TransformAndSink(parseLines.andThen(_.map(s => "P1: " + s)), ZSink.foreach(errors.offer))
+    case p if p == p2 => TransformAndSink(parseLines.andThen(_.map(s => "P2: " + s)), ZSink.foreach(errors.offer))
+  }
+} yield ()
+
          + +

          Creating reusable functions

          +

          The Process object contains several useful type aliases for writing functions that work with any process by +only specifying what redirection channels we want unbounded.

          + +

          The UnboundProcess represents a process which is fully unbound, no redirection has been done yet. It is +defined as follows:

          + +
          type UnboundProcess = Process[Unit, Unit]
+    with RedirectableInput[UnboundOEProcess]
+    with RedirectableOutput[UnboundIEProcess[*]]
+    with RedirectableError[UnboundIOProcess[*]]
+
          + +

          where UnboundIOProcess[E] for example represents a process which has its error output already bound.

          + +

          These type aliases can be used to define functions performing redirection on arbitrary processes, for example:

          + +
          def logErrors[P <: Process.UnboundEProcess[_]](proc: P) = {
+   val target = TransformAndSink(
+     ZPipeline.utf8Decode.mapError(UnknownProxError.apply) >>> ZPipeline.splitLines,
+     ZSink.foreach((line: String) => ZIO.debug(line))) 
+   proc !> target 
+}
+
+val proc4 = logErrors(Process("something"))
+// proc4: Process[_, Unit] = ProcessImplE(
+//   command = "something",
+//   arguments = List(),
+//   workingDirectory = None,
+//   environmentVariables = Map(),
+//   removedEnvironmentVariables = Set(),
+//   outputRedirection = StdOut(),
+//   runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@1fdd241b,
+//   errorRedirection = OutputStreamToSink(
+//     sink = TransformAndSink(
+//       transform = io.github.vigoo.prox.ProxZStream$TransformAndSink$$$Lambda$10991/0x0000000803237040@440a1cdc,
+//       sink = zio.stream.ZSink@6e1f2307
+//     ),
+//     chunkSize = 8192
+//   ),
+//   runErrorStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10902/0x0000000803103840@1c3ed5df,
+//   inputRedirection = StdIn()
+// )
+
          +
          \ No newline at end of file diff --git a/docs/zstream/running.html b/docs/zstream/running.html new file mode 100644 index 00000000..08f41427 --- /dev/null +++ b/docs/zstream/running.html @@ -0,0 +1,90 @@ +prox: Running processes

          Running processes and process groups

          + +

          There are three methods for running a process:

          + +
            +
          • The run method is the simplest one, it starts the process and then blocks the current fiber until it terminates
            • +
          • The start method starts the process and returns a fiber packed into a resource. The fiber finishes when the process terminates. Canceling the fiber terminates the process.
            • +
          • The startProcess method returns a RunningProcess[O, E] interface that allows advanced some operations
            • +
          + +

          Similarly for a process group, there is a run, a start and a startProcessGroup method but with different result types.

          + +

          Let’s see some examples!

          + +
          implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner 
+
+val process = Process("echo", List("hello"))
+
+val result1 = process.run()
+val result2 = ZIO.scoped {
+  process.start().flatMap { fiber =>
+    fiber.join
+  }
+}
+
+val result3 = 
+  for { 
+    runningProcess <- process.startProcess()
+    _ <- runningProcess.kill()
+  } yield ()
+
          + +

          Both RunningProcess and RunningProcessGroup has the following methods:

          +
            +
          • waitForExit() waits until the process terminates
            • +
          • terminate() sends SIGTERM to the process
            • +
          • kill() sends SIGKILL to the process
            • +
          + +

          In addition RunningProcess also defines an isAlive check.

          + +

          Process execution result

          +

          The result of a process is represented by ProcessResult[O, E] defined as follows:

          + +
          trait ProcessResult[+O, +E] {
+  val exitCode: ExitCode
+  val output: O
+  val error: E
+}
+
          + +

          The type and value of output and error depends on what redirection was defined on the process.

          + +

          Process group execution result

          +

          The result of a process group is represented by ProcessGroupResult[O, E]:

          + +
          trait ProcessGroupResult[+O, +E] {
+  val exitCodes: Map[Process[Unit, Unit], ExitCode]
+  val output: O
+  val errors: Map[Process[Unit, Unit], E]
+}
+
          + +

          The keys of the maps are the original process values used in the piping operations.

          +
          \ No newline at end of file diff --git a/examples/externalpyproc/init.sh b/examples/externalpyproc/init.sh deleted file mode 100755 index 86de7abc..00000000 --- a/examples/externalpyproc/init.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/env bash - -set -eo pipefail -IFS=$'\n\t' - -rm -rf virtualenv -virtualenv --setuptools --no-site-packages -p python2.7 virtualenv diff --git a/examples/externalpyproc/test.py b/examples/externalpyproc/test.py deleted file mode 100644 index f7199b5a..00000000 --- a/examples/externalpyproc/test.py +++ /dev/null @@ -1,15 +0,0 @@ -import sys - -def run(): - stop = False - - while not stop: - line = sys.stdin.readline().strip() - - if len(line) == 0: - stop = True - else: - print line + "!?!?" - sys.stdout.flush() - -run() diff --git a/highlight/LICENSE b/highlight/LICENSE new file mode 100644 index 00000000..2250cc7e --- /dev/null +++ b/highlight/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) 2006, Ivan Sagalaev. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +* Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/highlight/highlight.pack.js b/highlight/highlight.pack.js new file mode 100644 index 00000000..d826a435 --- /dev/null +++ b/highlight/highlight.pack.js @@ -0,0 +1,2 @@ +/*! highlight.js v9.16.2 | BSD3 License | git.io/hljslicense */ +!function(e){var n="object"==typeof window&&window||"object"==typeof self&&self;"undefined"==typeof exports||exports.nodeType?n&&(n.hljs=e({}),"function"==typeof define&&define.amd&&define([],function(){return n.hljs})):e(exports)}(function(a){var f=[],i=Object.keys,b={},u={},n=/^(no-?highlight|plain|text)$/i,l=/\blang(?:uage)?-([\w-]+)\b/i,t=/((^(<[^>]+>|\t|)+|(?:\n)))/gm,r={case_insensitive:"cI",lexemes:"l",contains:"c",keywords:"k",subLanguage:"sL",className:"cN",begin:"b",beginKeywords:"bK",end:"e",endsWithParent:"eW",illegal:"i",excludeBegin:"eB",excludeEnd:"eE",returnBegin:"rB",returnEnd:"rE",variants:"v",IDENT_RE:"IR",UNDERSCORE_IDENT_RE:"UIR",NUMBER_RE:"NR",C_NUMBER_RE:"CNR",BINARY_NUMBER_RE:"BNR",RE_STARTERS_RE:"RSR",BACKSLASH_ESCAPE:"BE",APOS_STRING_MODE:"ASM",QUOTE_STRING_MODE:"QSM",PHRASAL_WORDS_MODE:"PWM",C_LINE_COMMENT_MODE:"CLCM",C_BLOCK_COMMENT_MODE:"CBCM",HASH_COMMENT_MODE:"HCM",NUMBER_MODE:"NM",C_NUMBER_MODE:"CNM",BINARY_NUMBER_MODE:"BNM",CSS_NUMBER_MODE:"CSSNM",REGEXP_MODE:"RM",TITLE_MODE:"TM",UNDERSCORE_TITLE_MODE:"UTM",COMMENT:"C",beginRe:"bR",endRe:"eR",illegalRe:"iR",lexemesRe:"lR",terminators:"t",terminator_end:"tE"},_="          ",m={classPrefix:"hljs-",tabReplace:null,useBR:!1,languages:void 0},c="of and for in not or if then".split(" ");function C(e){return e.replace(/&/g,"&").replace(//g,">")}function E(e){return e.nodeName.toLowerCase()}function o(e){return n.test(e)}function s(e){var n,t={},r=Array.prototype.slice.call(arguments,1);for(n in e)t[n]=e[n];return r.forEach(function(e){for(n in e)t[n]=e[n]}),t}function g(e){var a=[];return function e(n,t){for(var r=n.firstChild;r;r=r.nextSibling)3===r.nodeType?t+=r.nodeValue.length:1===r.nodeType&&(a.push({event:"start",offset:t,node:r}),t=e(r,t),E(r).match(/br|hr|img|input/)||a.push({event:"stop",offset:t,node:r}));return t}(e,0),a}function d(e,n,t){var r=0,a="",i=[];function c(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset"}function l(e){a+=""}function o(e){("start"===e.event?u:l)(e.node)}for(;e.length||n.length;){var s=c();if(a+=C(t.substring(r,s[0].offset)),r=s[0].offset,s===e){for(i.reverse().forEach(l);o(s.splice(0,1)[0]),(s=c())===e&&s.length&&s[0].offset===r;);i.reverse().forEach(u)}else"start"===s[0].event?i.push(s[0].node):i.pop(),o(s.splice(0,1)[0])}return a+C(t.substr(r))}function R(n){return n.v&&!n.cached_variants&&(n.cached_variants=n.v.map(function(e){return s(n,{v:null},e)})),n.cached_variants?n.cached_variants:function e(n){return!!n&&(n.eW||e(n.starts))}(n)?[s(n,{starts:n.starts?s(n.starts):null})]:[n]}function v(e){if(r&&!e.langApiRestored){for(var n in e.langApiRestored=!0,r)e[n]&&(e[r[n]]=e[n]);(e.c||[]).concat(e.v||[]).forEach(v)}}function p(n,r){var a={};return"string"==typeof n?t("keyword",n):i(n).forEach(function(e){t(e,n[e])}),a;function t(t,e){r&&(e=e.toLowerCase()),e.split(" ").forEach(function(e){var n=e.split("|");a[n[0]]=[t,function(e,n){return n?Number(n):function(e){return-1!=c.indexOf(e.toLowerCase())}(e)?0:1}(n[0],n[1])]})}}function O(r){function s(e){return e&&e.source||e}function f(e,n){return new RegExp(s(e),"m"+(r.cI?"i":"")+(n?"g":""))}function a(a){var i,e,c={},u=[],l={},t=1;function n(e,n){c[t]=e,u.push([e,n]),t+=function(e){return new RegExp(e.toString()+"|").exec("").length-1}(n)+1}for(var r=0;r')+n+(t?"":_)}function l(){R+=null!=g.sL?function(){var e="string"==typeof g.sL;if(e&&!b[g.sL])return C(v);var n=e?x(g.sL,v,!0,d[g.sL]):B(v,g.sL.length?g.sL:void 0);return 0")+'"');if("end"===n.type){var r=function(e){var n=e[0],t=c(g,n);if(t){var r=g;for(r.skip?v+=n:(r.rE||r.eE||(v+=n),l(),r.eE&&(v=n));g.cN&&(R+=_),g.skip||g.sL||(p+=g.relevance),(g=g.parent)!==t.parent;);return t.starts&&(t.endSameAsBegin&&(t.starts.eR=t.eR),o(t.starts)),r.rE?0:n.length}}(n);if(null!=r)return r}return v+=t,t.length}var E=S(e);if(!E)throw new Error('Unknown language: "'+e+'"');O(E);var r,g=n||E,d={},R="";for(r=g;r!==E;r=r.parent)r.cN&&(R=u(r.cN,"",!0)+R);var v="",p=0;try{for(var M,N,h=0;g.t.lastIndex=h,M=g.t.exec(a);)N=t(a.substring(h,M.index),M),h=M.index+N;for(t(a.substr(h)),r=g;r.parent;r=r.parent)r.cN&&(R+=_);return{relevance:p,value:R,i:!1,language:e,top:g}}catch(e){if(e.message&&-1!==e.message.indexOf("Illegal"))return{i:!0,relevance:0,value:C(a)};throw e}}function B(t,e){e=e||m.languages||i(b);var r={relevance:0,value:C(t)},a=r;return e.filter(S).filter(T).forEach(function(e){var n=x(e,t,!1);n.language=e,n.relevance>a.relevance&&(a=n),n.relevance>r.relevance&&(a=r,r=n)}),a.language&&(r.second_best=a),r}function M(e){return m.tabReplace||m.useBR?e.replace(t,function(e,n){return m.useBR&&"\n"===e?"
          ":m.tabReplace?n.replace(/\t/g,m.tabReplace):""}):e}function N(e){var n,t,r,a,i,c=function(e){var n,t,r,a,i=e.className+" ";if(i+=e.parentNode?e.parentNode.className:"",t=l.exec(i))return S(t[1])?t[1]:"no-highlight";for(n=0,r=(i=i.split(/\s+/)).length;n/g,"\n"):n=e,i=n.textContent,r=c?x(c,i,!0):B(i),(t=g(n)).length&&((a=document.createElementNS("http://www.w3.org/1999/xhtml","div")).innerHTML=r.value,r.value=d(t,g(a),i)),r.value=M(r.value),e.innerHTML=r.value,e.className=function(e,n,t){var r=n?u[n]:t,a=[e.trim()];return e.match(/\bhljs\b/)||a.push("hljs"),-1===e.indexOf(r)&&a.push(r),a.join(" ").trim()}(e.className,c,r.language),e.result={language:r.language,re:r.relevance},r.second_best&&(e.second_best={language:r.second_best.language,re:r.second_best.relevance}))}function h(){if(!h.called){h.called=!0;var e=document.querySelectorAll("pre code");f.forEach.call(e,N)}}function S(e){return e=(e||"").toLowerCase(),b[e]||b[u[e]]}function T(e){var n=S(e);return n&&!n.disableAutodetect}return a.highlight=x,a.highlightAuto=B,a.fixMarkup=M,a.highlightBlock=N,a.configure=function(e){m=s(m,e)},a.initHighlighting=h,a.initHighlightingOnLoad=function(){addEventListener("DOMContentLoaded",h,!1),addEventListener("load",h,!1)},a.registerLanguage=function(n,e){var t=b[n]=e(a);v(t),t.rawDefinition=e.bind(null,a),t.aliases&&t.aliases.forEach(function(e){u[e]=n})},a.listLanguages=function(){return i(b)},a.getLanguage=S,a.autoDetection=T,a.inherit=s,a.IR=a.IDENT_RE="[a-zA-Z]\\w*",a.UIR=a.UNDERSCORE_IDENT_RE="[a-zA-Z_]\\w*",a.NR=a.NUMBER_RE="\\b\\d+(\\.\\d+)?",a.CNR=a.C_NUMBER_RE="(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",a.BNR=a.BINARY_NUMBER_RE="\\b(0b[01]+)",a.RSR=a.RE_STARTERS_RE="!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~",a.BE=a.BACKSLASH_ESCAPE={b:"\\\\[\\s\\S]",relevance:0},a.ASM=a.APOS_STRING_MODE={cN:"string",b:"'",e:"'",i:"\\n",c:[a.BE]},a.QSM=a.QUOTE_STRING_MODE={cN:"string",b:'"',e:'"',i:"\\n",c:[a.BE]},a.PWM=a.PHRASAL_WORDS_MODE={b:/\b(a|an|the|are|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such|will|you|your|they|like|more)\b/},a.C=a.COMMENT=function(e,n,t){var r=a.inherit({cN:"comment",b:e,e:n,c:[]},t||{});return r.c.push(a.PWM),r.c.push({cN:"doctag",b:"(?:TODO|FIXME|NOTE|BUG|XXX):",relevance:0}),r},a.CLCM=a.C_LINE_COMMENT_MODE=a.C("//","$"),a.CBCM=a.C_BLOCK_COMMENT_MODE=a.C("/\\*","\\*/"),a.HCM=a.HASH_COMMENT_MODE=a.C("#","$"),a.NM=a.NUMBER_MODE={cN:"number",b:a.NR,relevance:0},a.CNM=a.C_NUMBER_MODE={cN:"number",b:a.CNR,relevance:0},a.BNM=a.BINARY_NUMBER_MODE={cN:"number",b:a.BNR,relevance:0},a.CSSNM=a.CSS_NUMBER_MODE={cN:"number",b:a.NR+"(%|em|ex|ch|rem|vw|vh|vmin|vmax|cm|mm|in|pt|pc|px|deg|grad|rad|turn|s|ms|Hz|kHz|dpi|dpcm|dppx)?",relevance:0},a.RM=a.REGEXP_MODE={cN:"regexp",b:/\//,e:/\/[gimuy]*/,i:/\n/,c:[a.BE,{b:/\[/,e:/\]/,relevance:0,c:[a.BE]}]},a.TM=a.TITLE_MODE={cN:"title",b:a.IR,relevance:0},a.UTM=a.UNDERSCORE_TITLE_MODE={cN:"title",b:a.UIR,relevance:0},a.METHOD_GUARD={b:"\\.\\s*"+a.UIR,relevance:0},a});hljs.registerLanguage("java",function(e){var a="false synchronized int abstract float private char boolean var static null if const for true while long strictfp finally protected import native final void enum else break transient catch instanceof byte super volatile case assert short package default double public try this switch continue throws protected public private module requires exports do",t={cN:"number",b:"\\b(0[bB]([01]+[01_]+[01]+|[01]+)|0[xX]([a-fA-F0-9]+[a-fA-F0-9_]+[a-fA-F0-9]+|[a-fA-F0-9]+)|(([\\d]+[\\d_]+[\\d]+|[\\d]+)(\\.([\\d]+[\\d_]+[\\d]+|[\\d]+))?|\\.([\\d]+[\\d_]+[\\d]+|[\\d]+))([eE][-+]?\\d+)?)[lLfF]?",relevance:0};return{aliases:["jsp"],k:a,i:/<\/|#/,c:[e.C("/\\*\\*","\\*/",{relevance:0,c:[{b:/\w+@/,relevance:0},{cN:"doctag",b:"@[A-Za-z]+"}]}),e.CLCM,e.CBCM,e.ASM,e.QSM,{cN:"class",bK:"class interface",e:/[{;=]/,eE:!0,k:"class interface",i:/[:"\[\]]/,c:[{bK:"extends implements"},e.UTM]},{bK:"new throw return else",relevance:0},{cN:"function",b:"([À-ʸa-zA-Z_$][À-ʸa-zA-Z_$0-9]*(<[À-ʸa-zA-Z_$][À-ʸa-zA-Z_$0-9]*(\\s*,\\s*[À-ʸa-zA-Z_$][À-ʸa-zA-Z_$0-9]*)*>)?\\s+)+"+e.UIR+"\\s*\\(",rB:!0,e:/[{;=]/,eE:!0,k:a,c:[{b:e.UIR+"\\s*\\(",rB:!0,relevance:0,c:[e.UTM]},{cN:"params",b:/\(/,e:/\)/,k:a,relevance:0,c:[e.ASM,e.QSM,e.CNM,e.CBCM]},e.CLCM,e.CBCM]},t,{cN:"meta",b:"@[A-Za-z]+"}]}});hljs.registerLanguage("scala",function(e){var t={cN:"subst",v:[{b:"\\$[A-Za-z0-9_]+"},{b:"\\${",e:"}"}]},a={cN:"string",v:[{b:'"',e:'"',i:"\\n",c:[e.BE]},{b:'"""',e:'"""',relevance:10},{b:'[a-z]+"',e:'"',i:"\\n",c:[e.BE,t]},{cN:"string",b:'[a-z]+"""',e:'"""',c:[t],relevance:10}]},c={cN:"type",b:"\\b[A-Z][A-Za-z0-9_]*",relevance:0},r={cN:"title",b:/[^0-9\n\t "'(),.`{}\[\]:;][^\n\t "'(),.`{}\[\]:;]+|[^0-9\n\t "'(),.`{}\[\]:;=]/,relevance:0},n={cN:"class",bK:"class object trait type",e:/[:={\[\n;]/,eE:!0,c:[{bK:"extends with",relevance:10},{b:/\[/,e:/\]/,eB:!0,eE:!0,relevance:0,c:[c]},{cN:"params",b:/\(/,e:/\)/,eB:!0,eE:!0,relevance:0,c:[c]},r]},l={cN:"function",bK:"def",e:/[:={\[(\n;]/,eE:!0,c:[r]};return{k:{literal:"true false null",keyword:"type yield lazy override def with val var sealed abstract private trait object if forSome for while throw finally protected extends import final return else break new catch super class case package default try this match continue throws implicit"},c:[e.CLCM,e.CBCM,a,{cN:"symbol",b:"'\\w[\\w\\d_]*(?!')"},c,l,n,e.CNM,{cN:"meta",b:"@[A-Za-z]+"}]}});hljs.registerLanguage("bash",function(e){var t={cN:"variable",v:[{b:/\$[\w\d#@][\w\d_]*/},{b:/\$\{(.*?)}/}]},a={cN:"string",b:/"/,e:/"/,c:[e.BE,t,{cN:"variable",b:/\$\(/,e:/\)/,c:[e.BE]}]};return{aliases:["sh","zsh"],l:/\b-?[a-z\._]+\b/,k:{keyword:"if then else elif fi for while in do done case esac function",literal:"true false",built_in:"break cd continue eval exec exit export getopts hash pwd readonly return shift test times trap umask unset alias bind builtin caller command declare echo enable help let local logout mapfile printf read readarray source type typeset ulimit unalias set shopt autoload bg bindkey bye cap chdir clone comparguments compcall compctl compdescribe compfiles compgroups compquote comptags comptry compvalues dirs disable disown echotc echoti emulate fc fg float functions getcap getln history integer jobs kill limit log noglob popd print pushd pushln rehash sched setcap setopt stat suspend ttyctl unfunction unhash unlimit unsetopt vared wait whence where which zcompile zformat zftp zle zmodload zparseopts zprof zpty zregexparse zsocket zstyle ztcp",_:"-ne -eq -lt -gt -f -d -e -s -l -a"},c:[{cN:"meta",b:/^#![^\n]+sh\s*$/,relevance:10},{cN:"function",b:/\w[\w\d_]*\s*\(\s*\)\s*\{/,rB:!0,c:[e.inherit(e.TM,{b:/\w[\w\d_]*/})],relevance:0},e.HCM,a,{cN:"",b:/\\"/},{cN:"string",b:/'/,e:/'/},t]}}); \ No newline at end of file diff --git a/highlight/styles/vs.css b/highlight/styles/vs.css new file mode 100644 index 00000000..c5d07d31 --- /dev/null +++ b/highlight/styles/vs.css @@ -0,0 +1,68 @@ +/* + +Visual Studio-like style based on original C# coloring by Jason Diamond + +*/ +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + background: white; + color: black; +} + +.hljs-comment, +.hljs-quote, +.hljs-variable { + color: #008000; +} + +.hljs-keyword, +.hljs-selector-tag, +.hljs-built_in, +.hljs-name, +.hljs-tag { + color: #00f; +} + +.hljs-string, +.hljs-title, +.hljs-section, +.hljs-attribute, +.hljs-literal, +.hljs-template-tag, +.hljs-template-variable, +.hljs-type, +.hljs-addition { + color: #a31515; +} + +.hljs-deletion, +.hljs-selector-attr, +.hljs-selector-pseudo, +.hljs-meta { + color: #2b91af; +} + +.hljs-doctag { + color: #808080; +} + +.hljs-attr { + color: #f00; +} + +.hljs-symbol, +.hljs-bullet, +.hljs-link { + color: #00b0e8; +} + + +.hljs-emphasis { + font-style: italic; +} + +.hljs-strong { + font-weight: bold; +} diff --git a/img/favicon114x114.png b/img/favicon114x114.png new file mode 100644 index 00000000..a1c6ff0e Binary files /dev/null and b/img/favicon114x114.png differ diff --git a/img/favicon120x120.png b/img/favicon120x120.png new file mode 100644 index 00000000..32f480e0 Binary files /dev/null and b/img/favicon120x120.png differ diff --git a/img/favicon128x128.png b/img/favicon128x128.png new file mode 100644 index 00000000..a19298e8 Binary files /dev/null and b/img/favicon128x128.png differ diff --git a/img/favicon144x144.png b/img/favicon144x144.png new file mode 100644 index 00000000..305a0f00 Binary files /dev/null and b/img/favicon144x144.png differ diff --git a/img/favicon150x150.png b/img/favicon150x150.png new file mode 100644 index 00000000..6ed8c398 Binary files /dev/null and b/img/favicon150x150.png differ diff --git a/img/favicon152x152.png b/img/favicon152x152.png new file mode 100644 index 00000000..588ef3be Binary files /dev/null and b/img/favicon152x152.png differ diff --git a/img/favicon16x16.png b/img/favicon16x16.png new file mode 100644 index 00000000..c2855832 Binary files /dev/null and b/img/favicon16x16.png differ diff --git a/img/favicon196x196.png b/img/favicon196x196.png new file mode 100644 index 00000000..f9056813 Binary files /dev/null and b/img/favicon196x196.png differ diff --git a/img/favicon24x24.png b/img/favicon24x24.png new file mode 100644 index 00000000..a902555c Binary files /dev/null and b/img/favicon24x24.png differ diff --git a/img/favicon310x150.png b/img/favicon310x150.png new file mode 100644 index 00000000..59d939b3 Binary files /dev/null and b/img/favicon310x150.png differ diff --git a/img/favicon310x310.png b/img/favicon310x310.png new file mode 100644 index 00000000..c0f49c4b Binary files /dev/null and b/img/favicon310x310.png differ diff --git a/img/favicon32x32.png b/img/favicon32x32.png new file mode 100644 index 00000000..eeb94977 Binary files /dev/null and b/img/favicon32x32.png differ diff --git a/img/favicon48x48.png b/img/favicon48x48.png new file mode 100644 index 00000000..47191429 Binary files /dev/null and b/img/favicon48x48.png differ diff --git a/img/favicon57x57.png b/img/favicon57x57.png new file mode 100644 index 00000000..674665d9 Binary files /dev/null and b/img/favicon57x57.png differ diff --git a/img/favicon60x60.png b/img/favicon60x60.png new file mode 100644 index 00000000..53ce2de1 Binary files /dev/null and b/img/favicon60x60.png differ diff --git a/img/favicon64x64.png b/img/favicon64x64.png new file mode 100644 index 00000000..4d617902 Binary files /dev/null and b/img/favicon64x64.png differ diff --git a/img/favicon70x70.png b/img/favicon70x70.png new file mode 100644 index 00000000..e8f7b461 Binary files /dev/null and b/img/favicon70x70.png differ diff --git a/img/favicon72x72.png b/img/favicon72x72.png new file mode 100644 index 00000000..07c5a7e0 Binary files /dev/null and b/img/favicon72x72.png differ diff --git a/img/favicon76x76.png b/img/favicon76x76.png new file mode 100644 index 00000000..de28d7a5 Binary files /dev/null and b/img/favicon76x76.png differ diff --git a/img/favicon96x96.png b/img/favicon96x96.png new file mode 100644 index 00000000..6e9a7513 Binary files /dev/null and b/img/favicon96x96.png differ diff --git a/img/features-header.svg b/img/features-header.svg new file mode 100644 index 00000000..fe2f1539 --- /dev/null +++ b/img/features-header.svg @@ -0,0 +1,83 @@ + + + + header-image + Created with Sketch. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/img/first-feature-icon.svg b/img/first-feature-icon.svg new file mode 100644 index 00000000..db2f82c7 --- /dev/null +++ b/img/first-feature-icon.svg @@ -0,0 +1,15 @@ + + + + features01 + Created with Sketch. + + + + + + + + + + \ No newline at end of file diff --git a/img/first_icon.png b/img/first_icon.png new file mode 100644 index 00000000..0283901e Binary files /dev/null and b/img/first_icon.png differ diff --git a/img/first_icon2x.png b/img/first_icon2x.png new file mode 100644 index 00000000..4a0644df Binary files /dev/null and b/img/first_icon2x.png differ diff --git a/img/jumbotron_pattern.png b/img/jumbotron_pattern.png new file mode 100644 index 00000000..ec5dde12 Binary files /dev/null and b/img/jumbotron_pattern.png differ diff --git a/img/jumbotron_pattern2x.png b/img/jumbotron_pattern2x.png new file mode 100644 index 00000000..0121a2e7 Binary files /dev/null and b/img/jumbotron_pattern2x.png differ diff --git a/img/light-navbar-brand.svg b/img/light-navbar-brand.svg new file mode 100644 index 00000000..449f9f6c --- /dev/null +++ b/img/light-navbar-brand.svg @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/img/light-sidebar-brand.svg b/img/light-sidebar-brand.svg new file mode 100644 index 00000000..bd22d534 --- /dev/null +++ b/img/light-sidebar-brand.svg @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/img/light_navbar_brand.png b/img/light_navbar_brand.png new file mode 100644 index 00000000..da8752bb Binary files /dev/null and b/img/light_navbar_brand.png differ diff --git a/img/navbar_brand.png b/img/navbar_brand.png new file mode 100644 index 00000000..1c2333c3 Binary files /dev/null and b/img/navbar_brand.png differ diff --git a/img/navbar_brand2x.png b/img/navbar_brand2x.png new file mode 100644 index 00000000..40b50ced Binary files /dev/null and b/img/navbar_brand2x.png differ diff --git a/docs/src/microsite/img/second-feature-icon.svg b/img/second-feature-icon.svg similarity index 100% rename from docs/src/microsite/img/second-feature-icon.svg rename to img/second-feature-icon.svg diff --git a/img/second_icon.png b/img/second_icon.png new file mode 100644 index 00000000..0c7749cb Binary files /dev/null and b/img/second_icon.png differ diff --git a/img/second_icon2x.png b/img/second_icon2x.png new file mode 100644 index 00000000..439b643c Binary files /dev/null and b/img/second_icon2x.png differ diff --git a/img/sidebar_brand.png b/img/sidebar_brand.png new file mode 100644 index 00000000..8c4a1f6d Binary files /dev/null and b/img/sidebar_brand.png differ diff --git a/img/sidebar_brand2x.png b/img/sidebar_brand2x.png new file mode 100644 index 00000000..652837d4 Binary files /dev/null and b/img/sidebar_brand2x.png differ diff --git a/docs/src/microsite/img/third-feature-icon.svg b/img/third-feature-icon.svg similarity index 100% rename from docs/src/microsite/img/third-feature-icon.svg rename to img/third-feature-icon.svg diff --git a/img/third_icon.png b/img/third_icon.png new file mode 100644 index 00000000..ba07d7c1 Binary files /dev/null and b/img/third_icon.png differ diff --git a/img/third_icon2x.png b/img/third_icon2x.png new file mode 100644 index 00000000..030e8f42 Binary files /dev/null and b/img/third_icon2x.png differ diff --git a/index.html b/index.html new file mode 100644 index 00000000..88dd88fe --- /dev/null +++ b/index.html @@ -0,0 +1,32 @@ +prox: prox: Home

          prox

          A Scala library for working with system processes

          View on GitHub
          +

          Type safe

          Define the execution of one or more system processes in a type safe way

          Learn More
          + +

          Purely functional

          Compose the process execution as an IO effect

          Learn More
          + +

          Streaming

          Redirect input, output and error to/from functional streams

          Learn More
          +
          \ No newline at end of file diff --git a/js/docs.js b/js/docs.js new file mode 100644 index 00000000..49eb7f42 --- /dev/null +++ b/js/docs.js @@ -0,0 +1,163 @@ +/** + * Toggle an specific class to the received DOM element. + * @param {string} elemSelector The query selector specifying the target element. + * @param {string} [activeClass='active'] The class to be applied/removed. + */ +function toggleClass(elemSelector, activeClass = "active") { + const elem = document.querySelector(elemSelector); + if (elem) { + elem.classList.toggle(activeClass); + } +} + +/** + * Toggle specific classes to an array of corresponding DOM elements. + * @param {Array} elemSelectors The query selectors specifying the target elements. + * @param {Array} activeClasses The classes to be applied/removed. + */ +function toggleClasses(elemSelectors, activeClasses) { + elemSelectors.map((elemSelector, idx) => { + toggleClass(elemSelector, activeClasses[idx]); + }); +} + +/** + * Remove active class from siblings DOM elements and apply it to event target. + * @param {Element} element The element receiving the class, and whose siblings will lose it. + * @param {string} [activeClass='active'] The class to be applied. + */ +function activate(element, activeClass = "active") { + [...element.parentNode.children].map(elem => + elem.classList.remove(activeClass) + ); + element.classList.add(activeClass); +} + +/** + * Remove active class from siblings parent DOM elements and apply it to element target parent. + * @param {Element} element The element receiving the class, and whose siblings will lose it. + * @param {string} [activeClass='active'] The class to be applied. + */ +function activateParent(element, activeClass = "active") { + const elemParent = element.parentNode; + activate(elemParent, activeClass); +} + +/** + * Remove active class from siblings parent DOM elements and apply it to element target parent. + * @param {Element} element The element receiving the class, and whose siblings will lose it. + * @param {string} [activeClass='active'] The class to be applied. + */ +function toggleParent(element, activeClass = "active") { + const elemParent = element.parentNode; + if (elemParent) { + elemParent.classList.toggle(activeClass); + } +} + +/** + * This will make the specified elements click event to show/hide the menu sidebar. + */ +function activateToggle() { + const menuToggles = document.querySelectorAll("#menu-toggle, #main-toggle"); + if (menuToggles) { + [...menuToggles].map(elem => { + elem.onclick = e => { + e.preventDefault(); + toggleClass("#wrapper", "toggled"); + }; + }); + } +} + +/** + * This will make the specified elements click event to behave as a menu + * parent entry, or a link, or sometimes both, depending on the context. + */ +function activateMenuNesting() { + const menuParents = document.querySelectorAll(".drop-nested"); + if (menuParents) { + [...menuParents].map(elem => { + elem.onclick = e => { + e.preventDefault(); + toggleParent(elem, "open"); + const elementType = e.currentTarget.tagName.toLowerCase(); + if (elementType === "a") { + const linkElement = e.currentTarget; + const linkElementParent = linkElement.parentNode; + const destination = linkElement.href; + if ( + destination !== window.location.href && + !linkElementParent.classList.contains("active") + ) { + window.location.href = destination; + } + } + }; + }); + } +} + +/** + * Aux function to retrieve repository stars and watchers count info from + * GitHub API and set it on its proper nodes. + */ +async function loadGitHubStats() { + const content = document.querySelector("#content"); + const ghOwner = content.dataset.githubOwner; + const ghRepo = content.dataset.githubRepo; + + if (ghOwner && ghRepo) { + const ghAPI = `https://api.github.com/repos/${ghOwner}/${ghRepo}`; + const ghDataResponse = await fetch(ghAPI); + const ghData = await ghDataResponse.json(); + const watchersElement = document.querySelector("#eyes"); + const starsElement = document.querySelector("#stars"); + watchersElement.textContent = ghData.subscribers_count; + starsElement.textContent = ghData.stargazers_count; + } +} + +/** + * Function to create an anchor with an specific id + * @param {string} id The corresponding id from which the href will be created. + * @returns {Element} The new created anchor. + */ +function anchorForId(id) { + const anchor = document.createElement("a"); + anchor.className = "header-link"; + anchor.href = `#${id}`; + anchor.innerHTML = ''; + return anchor; +} + +/** + * Aux function to retrieve repository stars and watchers count info from + * @param {string} level The specific level to select header from. + * @param {Element} containingElement The element receiving the anchor. + */ +function linkifyAnchors(level, containingElement) { + const headers = containingElement.getElementsByTagName(`h${level}`); + [...headers].map(header => { + if (typeof header.id !== "undefined" && header.id !== "") { + header.append(anchorForId(header.id)); + } + }); +} + +/** + * Function + */ +function linkifyAllLevels() { + const content = document.querySelector("#content"); + [...Array(7).keys()].map(level => { + linkifyAnchors(level, content); + }); +} + +window.addEventListener("DOMContentLoaded", () => { + activateToggle(); + activateMenuNesting(); + loadGitHubStats(); + linkifyAllLevels(); +}); diff --git a/js/main.js b/js/main.js new file mode 100644 index 00000000..01865e18 --- /dev/null +++ b/js/main.js @@ -0,0 +1,73 @@ +jQuery(document).ready(function() { + hljs.initHighlightingOnLoad(); + activeToggle(); + loadGitHubStats(); + linkifyAllLevels(".docs .content-wrapper"); +}); + + +function activeToggle() { + $("#menu-toggle").click(function(e) { + e.preventDefault(); + $("#wrapper").toggleClass("toggled"); + }); +} + +var anchorForId = function (id) { + var anchor = document.createElement("a"); + anchor.className = "header-link"; + anchor.href = "#" + id; + anchor.innerHTML = ""; + return anchor; +}; + +var linkifyAnchors = function (level, containingElement) { + var headers = containingElement.getElementsByTagName("h" + level); + for (var h = 0; h < headers.length; h++) { + var header = headers[h]; + + if (typeof header.id !== "undefined" && header.id !== "") { + header.appendChild(anchorForId(header.id)); + } + } +}; + +var linkifyAllLevels = function (blockSelector) { + var contentBlock = document.querySelector(blockSelector); + if (!contentBlock) { + return; + } + for (var level = 1; level <= 6; level++) { + linkifyAnchors(level, contentBlock); + } +}; + +var baseURL = window.location.href; + +function shareSiteFacebook(text) { + launchPopup('http://www.facebook.com/sharer/sharer.php?u='+baseURL+'&t=' + text); +} + +function shareSiteTwitter(text) { + launchPopup('https://twitter.com/home?status=' + text); + return false; +} + +function launchPopup(url) { + window.open(url, 'Social Share', 'height=320, width=640, toolbar=no, menubar=no, scrollbars=no, resizable=no, location=no, directories=no, status=no'); +} + +function loadGitHubStats() { + var content = $("#content"); + var githubOwner = content.attr("data-github-owner") + var githubRepo = content.attr("data-github-repo") + + if(githubOwner && githubRepo) { + var gitHubAPI = "https://api.github.com/repos/" + githubOwner + "/" + githubRepo + "?callback=?"; + $.getJSON(gitHubAPI).done(function(data) { + $('#eyes').text(data.data.subscribers_count); + $('#stars').text(data.data.stargazers_count); + }); + } + +} diff --git a/js/search.js b/js/search.js new file mode 100644 index 00000000..661db1e7 --- /dev/null +++ b/js/search.js @@ -0,0 +1,265 @@ +// When the user clicks on the search box, we want to toggle the search dropdown +function displayToggleSearch(e) { + e.preventDefault(); + e.stopPropagation(); + + closeDropdownSearch(e); + + if (idx === null) { + console.log("Building search index..."); + prepareIdxAndDocMap(); + console.log("Search index built."); + } + const dropdown = document.querySelector("#search-dropdown-content"); + if (dropdown) { + if (!dropdown.classList.contains("show")) { + dropdown.classList.add("show"); + } + document.addEventListener("click", closeDropdownSearch); + document.addEventListener("keydown", searchOnKeyDown); + document.addEventListener("keyup", searchOnKeyUp); + } +} + +//We want to prepare the index only after clicking the search bar +var idx = null +const docMap = new Map() + +function prepareIdxAndDocMap() { + const docs = [ + { + "title": "Blog posts", + "url": "/prox/docs/blogposts.html", + "content": "Blog posts The following series of blog posts are based on the development of prox: Part 1 - type level programming Part 2 - Akka Streams with Cats Effect Part 3 - Effect abstraction and ZIO Part 4 - Simplified redesign" + } , + { + "title": "Custom runners", + "url": "/prox/docs/zstream/custom-runners.html", + "content": "Customizing the runner The runner is responsible for stating the native processes and wiring all the redirections together. The default implementation is called JVMProcessRunner. There are use cases when providing a custom runner makes sense. One such use case could be to launch external processes within a docker container in case of running on a development machine (for example from tests), while running them directly in production, when the whole service is running within the container. We can implement this scenario by using JVMProcessRunner in production and a custom DockerizedProcessRunner in tests, where we define the latter as follows: import java.nio.file.Path import java.util.UUID case class DockerImage(name: String) case class DockerContainer(name: String) case class DockerProcessInfo[DockerProcessInfo](container: DockerContainer, dockerProcessInfo: DockerProcessInfo) class DockerizedProcessRunner[Info](processRunner: ProcessRunner[Info], mountedDirectory: Path, workingDirectory: Path, image: DockerImage) extends ProcessRunner[DockerProcessInfo[Info]] { override def startProcess[O, E](process: Process[O, E]): ZIO[Any, ProxError, RunningProcess[O, E, DockerProcessInfo[Info]]] = { for { container <- generateContainerName runningProcess <- processRunner .startProcess(wrapInDocker(process, container)) } yield runningProcess.mapInfo(info => DockerProcessInfo(container, info)) } override def startProcessGroup[O, E](processGroup: ProcessGroup[O, E]): ZIO[Any, ProxError, RunningProcessGroup[O, E, DockerProcessInfo[Info]]] = { ZIO.foreach(processGroup.originalProcesses.toVector)(key => generateContainerName.map(c => key -> c)).flatMap { keyAndNames => val nameMap = keyAndNames.toMap val names = keyAndNames.map(_._2) val modifiedProcessGroup = processGroup.map(new ProcessGroup.Mapper[O, E] { def mapFirst[P <: Process[ZStream[Any, ProxError, Byte], E]](process: P): P = wrapInDocker(process, names.head).asInstanceOf[P] def mapInnerWithIdx[P <: Process.UnboundIProcess[ZStream[Any, ProxError, Byte], E]](process: P, idx: Int): P = wrapInDocker(process, names(idx)).asInstanceOf[P] def mapLast[P <: Process.UnboundIProcess[O, E]](process: P): P = wrapInDocker(process, names.last).asInstanceOf[P] }) processRunner.startProcessGroup(modifiedProcessGroup) .map(_.mapInfo { case (key, info) => DockerProcessInfo(nameMap(key), info) }) } } private def generateContainerName: ZIO[Any, ProxError, DockerContainer] = ZIO.attempt(DockerContainer(UUID.randomUUID().toString)).mapError(UnknownProxError) private def wrapInDocker[O, E](process: Process[O, E], container: DockerContainer): Process[O, E] = { val envVars = process.environmentVariables.flatMap { case (key, value) => List(\"-e\", s\"$key=$value\") }.toList process.withCommand(\"docker\").withArguments( \"run\" :: \"--name\" :: container.name :: \"-v\" :: mountedDirectory.toString :: \"-w\" :: workingDirectory.toString :: envVars ::: List(image.name, process.command) ::: process.arguments ) } }" + } , + { + "title": "Custom runners", + "url": "/prox/docs/fs2/custom-runners.html", + "content": "Customizing the runner The runner is responsible for stating the native processes and wiring all the redirections together. The default implementation is called JVMProcessRunner. There are use cases when providing a custom runner makes sense. One such use case could be to launch external processes within a docker container in case of running on a development machine (for example from tests), while running them directly in production, when the whole service is running within the container. We can implement this scenario by using JVMProcessRunner in production and a custom DockerizedProcessRunner in tests, where we define the latter as follows: import java.nio.file.Path import java.util.UUID case class DockerImage(name: String) case class DockerContainer(name: String) case class DockerProcessInfo[DockerProcessInfo](container: DockerContainer, dockerProcessInfo: DockerProcessInfo) class DockerizedProcessRunner[Info](processRunner: ProcessRunner[Info], mountedDirectory: Path, workingDirectory: Path, image: DockerImage) extends ProcessRunner[DockerProcessInfo[Info]] { override def startProcess[O, E](process: Process[O, E]): IO[RunningProcess[O, E, DockerProcessInfo[Info]]] = { for { container <- generateContainerName runningProcess <- processRunner .startProcess(wrapInDocker(process, container)) } yield runningProcess.mapInfo(info => DockerProcessInfo(container, info)) } override def startProcessGroup[O, E](processGroup: ProcessGroup[O, E]): IO[RunningProcessGroup[O, E, DockerProcessInfo[Info]]] = { Traverse[Vector].sequence(processGroup.originalProcesses.toVector.map(key => generateContainerName.map(c => key -> c))).flatMap { keyAndNames => val nameMap = keyAndNames.toMap val names = keyAndNames.map(_._2) val modifiedProcessGroup = processGroup.map(new ProcessGroup.Mapper[O, E] { def mapFirst[P <: Process[fs2.Stream[IO, Byte], E]](process: P): P = wrapInDocker(process, names.head).asInstanceOf[P] def mapInnerWithIdx[P <: Process.UnboundIProcess[fs2.Stream[IO, Byte], E]](process: P, idx: Int): P = wrapInDocker(process, names(idx)).asInstanceOf[P] def mapLast[P <: Process.UnboundIProcess[O, E]](process: P): P = wrapInDocker(process, names.last).asInstanceOf[P] }) processRunner.startProcessGroup(modifiedProcessGroup) .map(_.mapInfo { case (key, info) => DockerProcessInfo(nameMap(key), info) }) } } private def generateContainerName: IO[DockerContainer] = IO(DockerContainer(UUID.randomUUID().toString)) private def wrapInDocker[O, E](process: Process[O, E], container: DockerContainer): Process[O, E] = { val envVars = process.environmentVariables.flatMap { case (key, value) => List(\"-e\", s\"$key=$value\") }.toList process.withCommand(\"docker\").withArguments( \"run\" :: \"--name\" :: container.name :: \"-v\" :: mountedDirectory.toString :: \"-w\" :: workingDirectory.toString :: envVars ::: List(image.name, process.command) ::: process.arguments ) } }" + } , + { + "title": "Customizing environment", + "url": "/prox/docs/zstream/customize.html", + "content": "Customizing the environment The type returned by the Process constructor also implements the ProcessConfiguration trait, adding three methods that can be used to customize the working environment of the process to be started: Working directory The in method can be used to customize the working directory: import io.github.vigoo.prox.path._ val dir = home / \"tmp\" // dir: java.nio.file.Path = /home/runner/tmp val proc1 = Process(\"ls\") in dir // proc1: Process.ProcessImpl = ProcessImpl( // command = \"ls\", // arguments = List(), // workingDirectory = Some(value = /home/runner/tmp), // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@68413682, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@21441d72, // inputRedirection = StdIn() // ) Not that dir has the type java.nio.file.Path, and the home / tmp syntax is just a thin syntax extension to produce such values. Adding environment variables The with method can be used to add environment variables to the process in the following way: val proc2 = Process(\"echo\", List(\"$TEST\")) `with` (\"TEST\" -> \"Hello world\") // proc2: Process.ProcessImpl = ProcessImpl( // command = \"echo\", // arguments = List(\"$TEST\"), // workingDirectory = None, // environmentVariables = Map(\"TEST\" -> \"Hello world\"), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@3e325af1, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@5bd0336b, // inputRedirection = StdIn() // ) Removing environment variables The subprocess inherits the parent process environment, so it may be necessary to remove some already defined environment variables with the without method: val proc3 = Process(\"echo\" , List(\"$PATH\")) `without` \"PATH\" // proc3: Process.ProcessImpl = ProcessImpl( // command = \"echo\", // arguments = List(\"$PATH\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(\"PATH\"), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@3a44ebb5, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3b6ace02, // inputRedirection = StdIn() // ) Writing reusable functions Because these methods are part of the ProcessConfiguration capability, writing reusable functions require us to define a polymorphic function that requires this capability: import java.nio.file.Path def withHome[P <: ProcessLike with ProcessLikeConfiguration](home: Path, proc: P): P#Self = proc `with` (\"HOME\" -> home.toString) Then we can use it on any kind of process or process group (read about redirection to understand why there are multiple concrete process types): val proc4 = Process(\"echo\", List(\"$HOME\")) // proc4: Process.ProcessImpl = ProcessImpl( // command = \"echo\", // arguments = List(\"$HOME\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@17a3ee4c, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@4d32dcb8, // inputRedirection = StdIn() // ) val proc5 = withHome(home, proc4) // proc5: Process.ProcessImpl#Self = ProcessImpl( // command = \"echo\", // arguments = List(\"$HOME\"), // workingDirectory = None, // environmentVariables = Map(\"HOME\" -> \"/home/runner\"), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@17a3ee4c, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@4d32dcb8, // inputRedirection = StdIn() // ) val group1 = Process(\"grep\", List(\"ERROR\")) | Process(\"sort\") // group1: ProcessGroup.ProcessGroupImpl = ProcessGroupImpl( // firstProcess = ProcessImplO( // command = \"grep\", // arguments = List(\"ERROR\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = OutputStreamThroughPipe( // pipe = io.github.vigoo.prox.ProxZStream$$Lambda$10965/0x00000008031b7040@50368fe8, // runner = io.github.vigoo.prox.SyntaxModule$ProcessPiping$$Lambda$10723/0x00000008026f4840@3dc14132, // chunkSize = 8192 // ), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@35980948, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@6e94c45f, // inputRedirection = StdIn() // ), // innerProcesses = List(), // lastProcess = ProcessImpl( // command = \"sort\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@a395faa, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3d46470e, // inputRedirection = StdIn() // ), // originalProcesses = List( // ProcessImpl( // command = \"sort\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@a395faa, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3d46470e, // ... val group2 = withHome(home, group1) // group2: ProcessGroup.ProcessGroupImpl#Self = ProcessGroupImpl( // firstProcess = ProcessImplO( // command = \"grep\", // arguments = List(\"ERROR\"), // workingDirectory = None, // environmentVariables = Map(\"HOME\" -> \"/home/runner\"), // removedEnvironmentVariables = Set(), // outputRedirection = OutputStreamThroughPipe( // pipe = io.github.vigoo.prox.ProxZStream$$Lambda$10965/0x00000008031b7040@50368fe8, // runner = io.github.vigoo.prox.SyntaxModule$ProcessPiping$$Lambda$10723/0x00000008026f4840@3dc14132, // chunkSize = 8192 // ), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@35980948, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@6e94c45f, // inputRedirection = StdIn() // ), // innerProcesses = List(), // lastProcess = ProcessImpl( // command = \"sort\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(\"HOME\" -> \"/home/runner\"), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@a395faa, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3d46470e, // inputRedirection = StdIn() // ), // originalProcesses = List( // ProcessImpl( // command = \"sort\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@a395faa, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3d46470e, // ..." + } , + { + "title": "Customizing environment", + "url": "/prox/docs/fs2/customize.html", + "content": "Customizing the environment The type returned by the Process constructor also implements the ProcessConfiguration trait, adding three methods that can be used to customize the working environment of the process to be started: Working directory The in method can be used to customize the working directory: import io.github.vigoo.prox.path._ val dir = home / \"tmp\" // dir: java.nio.file.Path = /home/runner/tmp val proc1 = Process(\"ls\") in dir // proc1: Process.ProcessImpl = ProcessImpl( // command = \"ls\", // arguments = List(), // workingDirectory = Some(value = /home/runner/tmp), // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@2eb4bf64, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@497fbb3f, // inputRedirection = StdIn() // ) Not that dir has the type java.nio.file.Path, and the home / tmp syntax is just a thin syntax extension to produce such values. Adding environment variables The with method can be used to add environment variables to the process in the following way: val proc2 = Process(\"echo\", List(\"$TEST\")) `with` (\"TEST\" -> \"Hello world\") // proc2: Process.ProcessImpl = ProcessImpl( // command = \"echo\", // arguments = List(\"$TEST\"), // workingDirectory = None, // environmentVariables = Map(\"TEST\" -> \"Hello world\"), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@5171baaf, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1d4e323c, // inputRedirection = StdIn() // ) Removing environment variables The subprocess inherits the parent process environment, so it may be necessary to remove some already defined environment variables with the without method: val proc3 = Process(\"echo\" , List(\"$PATH\")) `without` \"PATH\" // proc3: Process.ProcessImpl = ProcessImpl( // command = \"echo\", // arguments = List(\"$PATH\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(\"PATH\"), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@7cbb3028, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3e7b00a1, // inputRedirection = StdIn() // ) Writing reusable functions Because these methods are part of the ProcessConfiguration capability, writing reusable functions require us to define a polymorphic function that requires this capability: import java.nio.file.Path def withHome[P <: ProcessLike with ProcessLikeConfiguration](home: Path, proc: P): P#Self = proc `with` (\"HOME\" -> home.toString) Then we can use it on any kind of process or process group (read about redirection to understand why there are multiple concrete process types): val proc4 = Process(\"echo\", List(\"$HOME\")) // proc4: Process.ProcessImpl = ProcessImpl( // command = \"echo\", // arguments = List(\"$HOME\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@62037103, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@e3070ad, // inputRedirection = StdIn() // ) val proc5 = withHome(home, proc4) // proc5: Process.ProcessImpl#Self = ProcessImpl( // command = \"echo\", // arguments = List(\"$HOME\"), // workingDirectory = None, // environmentVariables = Map(\"HOME\" -> \"/home/runner\"), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@62037103, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@e3070ad, // inputRedirection = StdIn() // ) val group1 = Process(\"grep\", List(\"ERROR\")) | Process(\"sort\") // group1: ProcessGroup.ProcessGroupImpl = ProcessGroupImpl( // firstProcess = ProcessImplO( // command = \"grep\", // arguments = List(\"ERROR\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = OutputStreamThroughPipe( // pipe = io.github.vigoo.prox.ProxFS2$$Lambda$10722/0x00000008026f6840@2baf2b33, // runner = io.github.vigoo.prox.SyntaxModule$ProcessPiping$$Lambda$10723/0x00000008026f4840@4db758ef, // chunkSize = 8192 // ), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@3445b333, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@39fd180e, // inputRedirection = StdIn() // ), // innerProcesses = List(), // lastProcess = ProcessImpl( // command = \"sort\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6b595ab1, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1cde0715, // inputRedirection = StdIn() // ), // originalProcesses = List( // ProcessImpl( // command = \"sort\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6b595ab1, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1cde0715, // ... val group2 = withHome(home, group1) // group2: ProcessGroup.ProcessGroupImpl#Self = ProcessGroupImpl( // firstProcess = ProcessImplO( // command = \"grep\", // arguments = List(\"ERROR\"), // workingDirectory = None, // environmentVariables = Map(\"HOME\" -> \"/home/runner\"), // removedEnvironmentVariables = Set(), // outputRedirection = OutputStreamThroughPipe( // pipe = io.github.vigoo.prox.ProxFS2$$Lambda$10722/0x00000008026f6840@2baf2b33, // runner = io.github.vigoo.prox.SyntaxModule$ProcessPiping$$Lambda$10723/0x00000008026f4840@4db758ef, // chunkSize = 8192 // ), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@3445b333, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@39fd180e, // inputRedirection = StdIn() // ), // innerProcesses = List(), // lastProcess = ProcessImpl( // command = \"sort\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(\"HOME\" -> \"/home/runner\"), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6b595ab1, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1cde0715, // inputRedirection = StdIn() // ), // originalProcesses = List( // ProcessImpl( // command = \"sort\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6b595ab1, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@1cde0715, // ..." + } , + { + "title": "Getting started", + "url": "/prox/docs/zstream/", + "content": "Getting started with prox First add one of the prox interfaces as a dependency: libraryDependencies += \"io.github.vigoo\" %% \"prox-zstream\" % \"0.7.3\" and import the ZIO specific API from: import io.github.vigoo.prox._ import io.github.vigoo.prox.zstream._ There is also an experimental version for ZIO 2, based on it’s snapshot releases: libraryDependencies += \"io.github.vigoo\" %% \"prox-zstream-2\" % \"0.7.3\" The code snippets in the documentation are based on the ZIO 1 version. Defining a process to run In prox a process to be executed is defined by a pure value which implements the Process[O, E] trait. The type parameters have the following meaning: O is the type of the output value after the system process has finished running E is the type of the error output value after the system process has finished running To create a simple process to be executed use the Process constructor: val proc1 = Process(\"ls\", List(\"-hal\")) // proc1: Process.ProcessImpl = ProcessImpl( // command = \"ls\", // arguments = List(\"-hal\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@7e0a87d1, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@7ae455b3, // inputRedirection = StdIn() // ) or we can use the string interpolator: val proc2 = proc\"ls -hal\" // proc2: Process.ProcessImpl = ProcessImpl( // command = \"ls\", // arguments = List(\"-hal\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@553fef4a, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@3db98ccc, // inputRedirection = StdIn() // ) Then we can customize the process execution by for example setting environment variables and working directory and redirect the input, output and error channels of the process pipe two or more processes together still staying on purely specification level. Running the process Once we have our process specification ready, we can start the process with one of the IO functions on process. But for this we first have to have a ProcessRunner implementation in scope. The default one is called JVMProcessRunner and it can be created in the following way: implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner Read the custom process runners page for an example of using a customized runner. With the runner in place we can use several methods to start the process. The simplest one is called run and it blocks the active thread until the process finishes running: proc1.run() // res0: ProxIO[ProcessResult[Unit, Unit]] = OnSuccess( // trace = \"io.github.vigoo.prox.ProxZStream.useResource(ProxZStream.scala:117)\", // first = OnSuccess( // trace = \"io.github.vigoo.prox.ProxZStream.useResource(ProxZStream.scala:117)\", // first = Sync( // trace = \"io.github.vigoo.prox.ProxZStream.useResource(ProxZStream.scala:117)\", // eval = zio.Scope$ReleaseMap$$$Lambda$10957/0x000000080319fc40@1727b0a5 // ), // successK = zio.ZIO$$Lambda$10959/0x000000080319e040@4fb6263f // ), // successK = zio.ZIO$ScopedPartiallyApplied$$$Lambda$10960/0x000000080319d040@6559d53c // ) The result of this IO action is a ProcessResult[O, E], with the ability to observe the exit code and the redirected output and error values. In our first example both O and E were Unit because the default is to redirect output and error to the standard output and standard error streams." + } , + { + "title": "Getting started", + "url": "/prox/docs/fs2/", + "content": "Getting started with prox First add one of the prox interfaces as a dependency: libraryDependencies += \"io.github.vigoo\" %% \"prox-fs2\" % \"0.7.3\" or for Cats Effect 3.x / FS2 3.x: libraryDependencies += \"io.github.vigoo\" %% \"prox-fs2-3\" % \"0.7.3\" and, assuming that we have a long living Blocker thread pool defined already, we can create the Prox module: val prox = ProxFS2[IO] // prox: ProxFS2[IO] = io.github.vigoo.prox.ProxFS2$$anon$1@3a0166d9 import prox._ We require F to implement the Concurrent type class, and for that we have to have an implicit context shifter in scope (this should be already available in an application using cats-effect). Defining a process to run In prox a process to be executed is defined by a pure value which implements the Process[O, E] trait. The type parameters have the following meaning: O is the type of the output value after the system process has finished running E is the type of the error output value after the system process has finished running To create a simple process to be executed use the Process constructor: val proc1 = Process(\"ls\", List(\"-hal\")) // proc1: Process.ProcessImpl = ProcessImpl( // command = \"ls\", // arguments = List(\"-hal\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@2bbb290f, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@6e7a64eb, // inputRedirection = StdIn() // ) or we can use the string interpolator: val proc2 = proc\"ls -hal\" // proc2: Process.ProcessImpl = ProcessImpl( // command = \"ls\", // arguments = List(\"-hal\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@6fecc06b, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@5eea44e1, // inputRedirection = StdIn() // ) Then we can customize the process execution by for example setting environment variables and working directory and redirect the input, output and error channels of the process pipe two or more processes together still staying on purely specification level. Running the process Once we have our process specification ready, we can start the process with one of the IO functions on process. But for this we first have to have a ProcessRunner implementation in scope. The default one is called JVMProcessRunner and it can be created in the following way: implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner Read the custom process runners page for an example of using a customized runner. With the runner in place we can use several methods to start the process. The simplest one is called run and it blocks the active thread until the process finishes running: proc1.run() // res0: ProxIO[ProcessResult[Unit, Unit]] = Uncancelable( // body = cats.effect.IO$$$Lambda$10820/0x000000080309a840@2c6bfd62, // event = cats.effect.tracing.TracingEvent$StackTrace // ) The result of this IO action is a ProcessResult[O, E], with the ability to observe the exit code and the redirected output and error values. In our first example both O and E were Unit because the default is to redirect output and error to the standard output and standard error streams." + } , + { + "title": "Getting started", + "url": "/prox/docs/", + "content": "Prox has two different interfaces: Cats Effect with FS2 ZIO with ZStream" + } , + { + "title": "prox: Home", + "url": "/prox/", + "content": "Prox is a Scala library for running system processes, plugging them to each other and redirecting them to streams." + } , + { + "title": "Migration", + "url": "/prox/docs/migration.html", + "content": "Migration from 0.1.x to 0.2 The start method on processes now requires a blockingExecutionContext argument Ignore has been renamed to Drain Log has been renamed to ToVector from 0.2 to 0.4 Process now takes the effect type as parameter, so in case of cats-effect, Process(...) becomes Process[IO](...) The start method on processes now gets a Blocker instead of an execution context from 0.4 to 0.5 0.5 is a complete rewrite of the original library, and the API changed a lot, especially if the process types were used in code to pass around / wrap them. Please refer to the other sections of the documentation to learn how to reimplement them. For simple use cases where constructing and running the processes directly the main differences are: Different operators / methods for different source and target types, see the page about redirection The need of an implicit process runner in scope New ways to start and wait for the process, see the page about runnning processes from 0.5 to 0.6 0.6 introduces the native ZIO/ZStream version of the library. For existing code the following differences apply: Instead of prox, the artifact is now called prox-fs2 Instead of global imports, the FS2 prox module now has to be constructed with the FS2 constructor and the API is imported from that Because the FS2 module captures the F[_] and the Blocker, they are no longer needed to pass on to the API functions and types" + } , + { + "title": "Process groups", + "url": "/prox/docs/zstream/processgroups.html", + "content": "Connecting processes together via pipes Connecting one process to another means that the standard output of the first process gets redirected to the standard input of the second process. This is implemented using the redirection capabilities described on the redirection page. The result of connecting one process to another is called a process group and it implements the trait ProcessGroup[O, E]. To create a process group, either: Use the | or via methods between two unbounded processes Use the | or via methods between an unbounded process group and an unbounded process It is important that the process group construction must always happen before any redirection, the type system enforces this by requiring the involved processes to be UnboundedProcess. :bulb: Process.UnboundedProcess is a type alias for a process with all the redirection capabilities Let’s see an example of simply pipeing: val group1 = Process(\"grep\", List(\"ERROR\")) | Process(\"sort\") val group2 = group1 | Process(\"uniq\", List(\"-c\")) A custom pipe (when using via) can be anything of the type ZStream[any, ProxError, Byte] => ZStream[any, ProxError, Byte]). The following not very useful example capitalizes each word coming through: val customPipe: ProxPipe[Byte, Byte] = (s: ZStream[Any, ProxError, Byte]) => s .via(ZPipeline.utf8Decode.mapError(UnknownProxError.apply)) // decode UTF-8 .via(ZPipeline.splitLines) // split to lines .map(_.split(' ').toVector) // split lines to words .map(v => v.map(_.capitalize).mkString(\" \")) .intersperse(\"\\n\") // remerge lines .flatMap(str => ZStream.fromIterable(str.getBytes(StandardCharsets.UTF_8))) // reencode val group3 = Process(\"echo\", List(\"hello world\")).via(customPipe).to(Process(\"wc\", List(\"-w\")))" + } , + { + "title": "Process groups", + "url": "/prox/docs/fs2/processgroups.html", + "content": "Connecting processes together via pipes Connecting one process to another means that the standard output of the first process gets redirected to the standard input of the second process. This is implemented using the redirection capabilities described on the redirection page. The result of connecting one process to another is called a process group and it implements the trait ProcessGroup[O, E]. To create a process group, either: Use the | or via methods between two unbounded processes Use the | or via methods between an unbounded process group and an unbounded process It is important that the process group construction must always happen before any redirection, the type system enforces this by requiring the involved processes to be UnboundedProcess. :bulb: Process.UnboundedProcess is a type alias for a process with all the redirection capabilities Let’s see an example of simply piping: val group1 = Process(\"grep\", List(\"ERROR\")) | Process(\"sort\") val group2 = group1 | Process(\"uniq\", List(\"-c\")) A custom pipe (when using via) can be anything of the type Pipe[F, Byte, Byte]. The following not very useful example capitalizes each word coming through: val customPipe: fs2.Pipe[IO, Byte, Byte] = (s: fs2.Stream[IO, Byte]) => s .through(fs2.text.utf8.decode) // decode UTF-8 .through(fs2.text.lines) // split to lines .map(_.split(' ').toVector) // split lines to words .map(v => v.map(_.capitalize).mkString(\" \")) .intersperse(\"\\n\") // remerge lines .through(fs2.text.utf8.encode) // encode as UTF-8 val group3 = Process(\"echo\", List(\"hello world\")).via(customPipe).to(Process(\"wc\", List(\"-w\")))" + } , + { + "title": "Redirection", + "url": "/prox/docs/zstream/redirection.html", + "content": "Redirecting input, output and error Similarly to customization, redirection is also implemented with capability traits. The ProcessIO type returned by the Process constructor implements all the three redirection capability traits: RedirectableInput marks that the standard input of the process is not bound yet RedirectableOutput marks that the standard output of the process is not bound yet RedirectableError marks that the standard error output of the process is not bound yet Each of the three channels can be only redirected once. The result type of each redirection method no longer implements the given capability. Let’s see an example of this (redirection methods are described below on this page): import zio._ import zio.stream._ import zio.prelude._ val proc1 = Process(\"echo\", List(\"Hello world\")) // proc1: Process.ProcessImpl = ProcessImpl( // command = \"echo\", // arguments = List(\"Hello world\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@3281308b, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@65fd9c21, // inputRedirection = StdIn() // ) val proc2 = proc1 ># ZPipeline.utf8Decode // proc2: Process.ProcessImplO[String] = ProcessImplO( // command = \"echo\", // arguments = List(\"Hello world\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = OutputStreamThroughPipe( // pipe = io.github.vigoo.prox.ProxZStream$$Lambda$10979/0x00000008031db840@30088784, // runner = io.github.vigoo.prox.RedirectionModule$RedirectableOutput$$Lambda$10898/0x0000000803107040@202f727d, // chunkSize = 8192 // ), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@1b110b9b, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@65fd9c21, // inputRedirection = StdIn() // ) It is no longer possible to redirect the output of proc2: val proc3 = proc2 >? (ZPipeline.utf8Decode >>> ZPipeline.splitLines) // error: value >? is not a member of io.github.vigoo.prox.zstream.Process.ProcessImplO[String] // did you mean !>?? // val proc3 = proc2 >? (ZPipeline.utf8Decode >>> ZPipeline.splitLines) // ^^^^^^^^ Many redirection methods have an operator version but all of them have alphanumberic variants as well. Input redirection Input redirection is enabled by the RedirectableInput trait. The following operations are supported: operator alternative parameter type what it does < fromFile java.nio.file.Path Natively attach a source file to STDIN < fromStream ZStream[Any, ProxError, Byte] Attach a ZIO byte stream to STDIN !< fromStream ZStream[Any, ProxError, Byte] Attach a ZIO byte stream to STDIN and flush after each chunk Output redirection Output redirection is enabled by the RedirectableOutput trait. The following operations are supported: operator alternative parameter type result type what it does > toFile java.nio.file.Path Unit Natively attach STDOUT to a file >> appendToFile java.nio.file.Path Unit Natively attach STDOUT to a file in append mode > toSink TransformAndSink[Byte, _] Unit Drains the STDOUT through the given sink ># toFoldMonoid [O: Identity](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) O Sends STDOUT through the stream and folds the result using its monoid instance >? toVector ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) Vector[O] Sends STDOUT through the stream and collects the results   drainOutput ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) Unit Drains the STDOUT through the given stream   foldOutput ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => R R Sends STDOUT through the stream and folds the result using a custom fold function All the variants that accept a stream transformation (ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O])) are also usable by directly passing a ZPipeline. TransformAndSink encapsulates a stream transformation and a unit sink. It is possible to use a sink directly if transformation is not needed. case class TransformAndSink[A, B](transform: ZStream[Any, ProxError, A] => ZStream[Any, ProxError, B], sink: ZSink[Any, ProxError, B, Any, Unit]) Error redirection Error redirection is enabled by the RedirectableError trait. The following operations are supported: operator alternative parameter type result type what it does !> errorToFile java.nio.file.Path Unit Natively attach STDERR to a file !>> appendErrorToFile java.nio.file.Path Unit Natively attach STDERR to a file in append mode !> errorToSink TransformAndSink[Byte, _] Unit Drains the STDERR through the given sink !># errorToFoldMonoid [O: Monoid](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) O Sends STDERR through the pipe and folds the result using its monoid instance !>? errorToVector ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) Vector[O] Sends STDERR through the pipe and collects the results   drainError ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) Unit Drains the STDERR through the given pipe   foldError ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => R R Sends STDERR through the pipe and folds the result using a custom fold function Redirection for process groups Process groups are two or more processes attached together through pipes. This connection is internally implemented using the above described redirection capabilities. This means that all but the first process has their inputs bound, and all but the last one has their outputs bound. Redirection of input and output for a process group is thus a well defined operation meaning redirection of input of the first process and redirection of output of the last process. For this reason the class created via process piping implements the RedirectableInput and RedirectableOutput traits described above. For the sake of simplicity the library does not support anymore the fully customizable per-process error redirection for process groups, but a reduced but still quite expressive version described by the RedirectableErrors trait. The methods in this trait define error redirection for all process in the group at once: operator alternative parameter type result type what it does !> errorsToSink TransformAndSink[Byte, _] Unit Drains the STDERR through the given sink !># errorsToFoldMonoid [O: Monoid](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) O Sends STDERR through the stream and folds the result using its monoid instance !>? errorsToVector ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) Vector[O] Sends STDERR through the stream and collects the results   drainErrors ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) Unit Drains the STDERR through the given stream   foldErrors ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => R R Sends STDERR through the stream and folds the result using a custom fold function Redirection to file is not possible through this interface as only a single path could be provided. The result of these redirections is accessible through the ProcessGroupResult interface as it is described in the running processes section. By using the RedirectableErrors.customizedPerProcess interface (having the type RedirectableErrors.CustomizedPerProcess) it is possible to customize the redirection targets per process while keeping their types uniform: operator alternative parameter type result type what it does   errorsToFile Process => java.nio.file.Path Unit Natively attach STDERR to a file   appendErrorsToFile Process => java.nio.file.Path Unit Natively attach STDERR to a file in append mode   errorsToSink Process => TransformAndSink[Byte, _] Unit Drains the STDERR through the given sink   errorsToFoldMonoid Process => [O: Monoid](ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) O Sends STDERR through the stream and folds the result using its monoid instance   errorsToVector Process => ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) Vector[O] Sends STDERR through the stream and collects the results   drainErrors Process => ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]) Unit Drains the STDERR through the given stream   foldErrors Process => ZStream[Any, ProxError, Byte] => ZStream[Any, ProxError, O]), R, (R, O) => R R Sends STDERR through the stream and folds the result using a custom fold function Let’s see an example of how this works! First we define a queue where we want to send error lines from all the involved processes, then we define the two processes separately, connect them with a pipe and customize the error redirection where we prefix the parsed lines based on which process they came from: for { errors <- Queue.unbounded[String] parseLines = (s: ZStream[Any, ProxError, Byte]) => s.via(ZPipeline.utf8Decode.mapError(UnknownProxError.apply) >>> ZPipeline.splitLines) p1 = Process(\"proc1\") p2 = Process(\"proc2\") group = (p1 | p2).customizedPerProcess.errorsToSink { case p if p == p1 => TransformAndSink(parseLines.andThen(_.map(s => \"P1: \" + s)), ZSink.foreach(errors.offer)) case p if p == p2 => TransformAndSink(parseLines.andThen(_.map(s => \"P2: \" + s)), ZSink.foreach(errors.offer)) } } yield () Creating reusable functions The Process object contains several useful type aliases for writing functions that work with any process by only specifying what redirection channels we want unbounded. The UnboundProcess represents a process which is fully unbound, no redirection has been done yet. It is defined as follows: type UnboundProcess = Process[Unit, Unit] with RedirectableInput[UnboundOEProcess] with RedirectableOutput[UnboundIEProcess[*]] with RedirectableError[UnboundIOProcess[*]] where UnboundIOProcess[E] for example represents a process which has its error output already bound. These type aliases can be used to define functions performing redirection on arbitrary processes, for example: def logErrors[P <: Process.UnboundEProcess[_]](proc: P) = { val target = TransformAndSink( ZPipeline.utf8Decode.mapError(UnknownProxError.apply) >>> ZPipeline.splitLines, ZSink.foreach((line: String) => ZIO.debug(line))) proc !> target } val proc4 = logErrors(Process(\"something\")) // proc4: Process[_, Unit] = ProcessImplE( // command = \"something\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@1fdd241b, // errorRedirection = OutputStreamToSink( // sink = TransformAndSink( // transform = io.github.vigoo.prox.ProxZStream$TransformAndSink$$$Lambda$10991/0x0000000803237040@440a1cdc, // sink = zio.stream.ZSink@6e1f2307 // ), // chunkSize = 8192 // ), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10902/0x0000000803103840@1c3ed5df, // inputRedirection = StdIn() // )" + } , + { + "title": "Redirection", + "url": "/prox/docs/fs2/redirection.html", + "content": "Redirecting input, output and error Similarly to customization, redirection is also implemented with capability traits. The ProcessIO type returned by the Process constructor implements all the three redirection capability traits: RedirectableInput marks that the standard input of the process is not bound yet RedirectableOutput marks that the standard output of the process is not bound yet RedirectableError marks that the standard error output of the process is not bound yet Each of the three channels can be only redirected once. The result type of each redirection method no longer implements the given capability. Let’s see an example of this (redirection methods are described below on this page): import cats.implicits._ val proc1 = Process(\"echo\", List(\"Hello world\")) // proc1: Process.ProcessImpl = ProcessImpl( // command = \"echo\", // arguments = List(\"Hello world\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@3c441db9, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@646dcd02, // inputRedirection = StdIn() // ) val proc2 = proc1 ># fs2.text.utf8.decode // proc2: Process.ProcessImplO[String] = ProcessImplO( // command = \"echo\", // arguments = List(\"Hello world\"), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = OutputStreamThroughPipe( // pipe = fs2.text$utf8$$$Lambda$10896/0x0000000803101040@2ef6a566, // runner = io.github.vigoo.prox.RedirectionModule$RedirectableOutput$$Lambda$10898/0x0000000803107040@13e21eb2, // chunkSize = 8192 // ), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10724/0x00000008026f7840@f5760a2, // errorRedirection = StdOut(), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10721/0x0000000802701040@646dcd02, // inputRedirection = StdIn() // ) It is no longer possible to redirect the output of proc2: val proc3 = proc2 >? fs2.text.utf8.decode[IO].andThen(fs2.text.lines) // error: value >? is not a member of repl.MdocSession.MdocApp.prox.Process.ProcessImplO[String] // did you mean !>?? // val proc3 = proc2 >? fs2.text.utf8.decode[IO].andThen(fs2.text.lines) // ^^^^^^^^ Many redirection methods have an operator version but all of them have alphanumberic variants as well. Input redirection Input redirection is enabled by the RedirectableInput trait. The following operations are supported: operator alternative parameter type what it does < fromFile java.nio.file.Path Natively attach a source file to STDIN < fromStream Stream[F, Byte] Attach an fs2 byte stream to STDIN !< fromStream Stream[F, Byte] Attach an fs2 byte stream to STDIN and flush after each chunk Output redirection Output redirection is enabled by the RedirectableOutput trait. The following operations are supported: operator alternative parameter type result type what it does > toFile java.nio.file.Path Unit Natively attach STDOUT to a file >> appendToFile java.nio.file.Path Unit Natively attach STDOUT to a file in append mode > toSink Pipe[F, Byte, Unit] Unit Drains the STDOUT through the given pipe ># toFoldMonoid [O: Monoid](Pipe[F, Byte, O] O Sends STDOUT through the pipe and folds the result using its monoid instance >? toVector Pipe[F, Byte, O] Vector[O] Sends STDOUT through the pipe and collects the results   drainOutput Pipe[F, Byte, O] Unit Drains the STDOUT through the given pipe   foldOutput Pipe[F, Byte, O], R, (R, O) => R R Sends STDOUT through the pipe and folds the result using a custom fold function Error redirection Error redirection is enabled by the RedirectableError trait. The following operations are supported: operator alternative parameter type result type what it does !> errorToFile java.nio.file.Path Unit Natively attach STDERR to a file !>> appendErrorToFile java.nio.file.Path Unit Natively attach STDERR to a file in append mode !> errorToSink Pipe[F, Byte, Unit] Unit Drains the STDERR through the given pipe !># errorToFoldMonoid [O: Monoid](Pipe[F, Byte, O] O Sends STDERR through the pipe and folds the result using its monoid instance !>? errorToVector Pipe[F, Byte, O] Vector[O] Sends STDERR through the pipe and collects the results   drainError Pipe[F, Byte, O] Unit Drains the STDERR through the given pipe   foldError Pipe[F, Byte, O], R, (R, O) => R R Sends STDERR through the pipe and folds the result using a custom fold function Redirection for process groups Process groups are two or more processes attached together through pipes. This connection is internally implemented using the above described redirection capabilities. This means that all but the first process has their inputs bound, and all but the last one has their outputs bound. Redirection of input and output for a process group is thus a well defined operation meaning redirection of input of the first process and redirection of output of the last process. For this reason the class created via process piping implements the RedirectableInput and RedirectableOutput traits described above. For the sake of simplicity the library does not support anymore the fully customizable per-process error redirection for process groups, but a reduced but still quite expressive version described by the RedirectableErrors trait. The methods in this trait define error redirection for all process in the group at once: operator alternative parameter type result type what it does !> errorsToSink Pipe[F, Byte, Unit] Unit Drains the STDERR through the given pipe !># errorsToFoldMonoid [O: Monoid](Pipe[F, Byte, O] O Sends STDERR through the pipe and folds the result using its monoid instance !>? errorsToVector Pipe[F, Byte, O] Vector[O] Sends STDERR through the pipe and collects the results   drainErrors Pipe[F, Byte, O] Unit Drains the STDERR through the given pipe   foldErrors Pipe[F, Byte, O], R, (R, O) => R R Sends STDERR through the pipe and folds the result using a custom fold function Redirection to file is not possible through this interface as only a single path could be provided. The result of these redirections is accessible through the ProcessGroupResult interface as it is described in the running processes section. By using the RedirectableErrors.customizedPerProcess interface (having the type RedirectableErrors.CustomizedPerProcess) it is possible to customize the redirection targets per process while keeping their types uniform: operator alternative parameter type result type what it does   errorsToFile Process => java.nio.file.Path Unit Natively attach STDERR to a file   appendErrorsToFile Process => java.nio.file.Path Unit Natively attach STDERR to a file in append mode   errorsToSink Process => Pipe[F, Byte, Unit] Unit Drains the STDERR through the given pipe   errorsToFoldMonoid Process => [O: Monoid](Pipe[F, Byte, O] O Sends STDERR through the pipe and folds the result using its monoid instance   errorsToVector Process => Pipe[F, Byte, O] Vector[O] Sends STDERR through the pipe and collects the results   drainErrors Process => Pipe[F, Byte, O] Unit Drains the STDERR through the given pipe   foldErrors Process => Pipe[F, Byte, O], R, (R, O) => R R Sends STDERR through the pipe and folds the result using a custom fold function Let’s see an example of how this works! First we define a queue where we want to send error lines from all the involved processes, then we define the two processes separately, connect them with a pipe and customize the error redirection where we prefix the parsed lines based on which process they came from: import cats.effect.std.Queue for { errors <- Queue.unbounded[IO, String] parseLines = fs2.text.utf8.decode[IO].andThen(fs2.text.lines) p1 = Process(\"proc1\") p2 = Process(\"proc2\") group = (p1 | p2).customizedPerProcess.errorsToSink { case p if p == p1 => parseLines.andThen(_.map(s => \"P1: \" + s)).andThen(_.evalMap(errors.offer)) case p if p == p2 => parseLines.andThen(_.map(s => \"P2: \" + s)).andThen(_.evalMap(errors.offer)) } } yield () Creating reusable functions The Process object contains several useful type aliases for writing functions that work with any process by only specifying what redirection channels we want unbounded. The UnboundProcess represents a process which is fully unbound, no redirection has been done yet. It is defined as follows: type UnboundProcess = Process[Unit, Unit] with RedirectableInput[UnboundOEProcess] with RedirectableOutput[UnboundIEProcess[*]] with RedirectableError[UnboundIOProcess[*]] where UnboundIOProcess[E] for example represents a process which has its error output already bound. These type aliases can be used to define functions performing redirection on arbitrary processes, for example: def logErrors[P <: Process.UnboundEProcess[_]](proc: P) = { val target = fs2.text.utf8.decode[IO].andThen(fs2.text.lines).andThen(_.evalMap(line => IO(println(line)))) proc !> target } val proc4 = logErrors(Process(\"something\")) // proc4: Process[_, Unit] = ProcessImplE( // command = \"something\", // arguments = List(), // workingDirectory = None, // environmentVariables = Map(), // removedEnvironmentVariables = Set(), // outputRedirection = StdOut(), // runOutputStream = io.github.vigoo.prox.ProcessModule$Process$$$Lambda$10720/0x00000008026f7040@465296ac, // errorRedirection = OutputStreamToSink( // sink = scala.Function1$$Lambda$10901/0x0000000803105040@4b7024b1, // chunkSize = 8192 // ), // runErrorStream = io.github.vigoo.prox.ProcessModule$Process$ProcessImpl$$Lambda$10902/0x0000000803103840@effd624, // inputRedirection = StdIn() // )" + } , + { + "title": "Running processes", + "url": "/prox/docs/zstream/running.html", + "content": "Running processes and process groups There are three methods for running a process: The run method is the simplest one, it starts the process and then blocks the current fiber until it terminates The start method starts the process and returns a fiber packed into a resource. The fiber finishes when the process terminates. Canceling the fiber terminates the process. The startProcess method returns a RunningProcess[O, E] interface that allows advanced some operations Similarly for a process group, there is a run, a start and a startProcessGroup method but with different result types. Let’s see some examples! implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner val process = Process(\"echo\", List(\"hello\")) val result1 = process.run() val result2 = ZIO.scoped { process.start().flatMap { fiber => fiber.join } } val result3 = for { runningProcess <- process.startProcess() _ <- runningProcess.kill() } yield () Both RunningProcess and RunningProcessGroup has the following methods: waitForExit() waits until the process terminates terminate() sends SIGTERM to the process kill() sends SIGKILL to the process In addition RunningProcess also defines an isAlive check. Process execution result The result of a process is represented by ProcessResult[O, E] defined as follows: trait ProcessResult[+O, +E] { val exitCode: ExitCode val output: O val error: E } The type and value of output and error depends on what redirection was defined on the process. Process group execution result The result of a process group is represented by ProcessGroupResult[O, E]: trait ProcessGroupResult[+O, +E] { val exitCodes: Map[Process[Unit, Unit], ExitCode] val output: O val errors: Map[Process[Unit, Unit], E] } The keys of the maps are the original process values used in the piping operations." + } , + { + "title": "Running processes", + "url": "/prox/docs/fs2/running.html", + "content": "Running processes and process groups There are three methods for running a process: The run method is the simplest one, it starts the process and then blocks the current fiber until it terminates The start method starts the process and returns a fiber packed into a resource. The fiber finishes when the process terminates. Canceling the fiber terminates the process. The startProcess method returns a RunningProcess[O, E] interface that allows advanced some operations Similarly for a process group, there is a run, a start and a startProcessGroup method but with different result types. Let’s see some examples! implicit val runner: ProcessRunner[JVMProcessInfo] = new JVMProcessRunner val process = Process(\"echo\", List(\"hello\")) val result1 = process.run() val result2 = process.start().flatMap { fiber => fiber.join } val result3 = for { runningProcess <- process.startProcess() _ <- runningProcess.kill() } yield () Both RunningProcess and RunningProcessGroup has the following methods: waitForExit() waits until the process terminates terminate() sends SIGTERM to the process kill() sends SIGKILL to the process In addition RunningProcess also defines an isAlive check. Process execution result The result of a process is represented by ProcessResult[O, E] defined as follows: trait ProcessResult[+O, +E] { val exitCode: ExitCode val output: O val error: E } The type and value of output and error depends on what redirection was defined on the process. Process group execution result The result of a process group is represented by ProcessGroupResult[O, E]: trait ProcessGroupResult[+O, +E] { val exitCodes: Map[Process[Unit, Unit], ExitCode] val output: O val errors: Map[Process[Unit, Unit], E] } The keys of the maps are the original process values used in the piping operations." + } , + ]; + + idx = lunr(function () { + this.ref("title"); + this.field("content"); + + docs.forEach(function (doc) { + this.add(doc); + }, this); + }); + + docs.forEach(function (doc) { + docMap.set(doc.title, doc.url); + }); +} + +// The onkeypress handler for search functionality +function searchOnKeyDown(e) { + const keyCode = e.keyCode; + const parent = e.target.parentElement; + const isSearchBar = e.target.id === "search-bar"; + const isSearchResult = parent ? parent.id.startsWith("result-") : false; + const isSearchBarOrResult = isSearchBar || isSearchResult; + + if (keyCode === 40 && isSearchBarOrResult) { + // On 'down', try to navigate down the search results + e.preventDefault(); + e.stopPropagation(); + selectDown(e); + } else if (keyCode === 38 && isSearchBarOrResult) { + // On 'up', try to navigate up the search results + e.preventDefault(); + e.stopPropagation(); + selectUp(e); + } else if (keyCode === 27 && isSearchBarOrResult) { + // On 'ESC', close the search dropdown + e.preventDefault(); + e.stopPropagation(); + closeDropdownSearch(e); + } +} + +// Search is only done on key-up so that the search terms are properly propagated +function searchOnKeyUp(e) { + // Filter out up, down, esc keys + const keyCode = e.keyCode; + const cannotBe = [40, 38, 27]; + const isSearchBar = e.target.id === "search-bar"; + const keyIsNotWrong = !cannotBe.includes(keyCode); + if (isSearchBar && keyIsNotWrong) { + // Try to run a search + runSearch(e); + } +} + +// Move the cursor up the search list +function selectUp(e) { + if (e.target.parentElement.id.startsWith("result-")) { + const index = parseInt(e.target.parentElement.id.substring(7)); + if (!isNaN(index) && (index > 0)) { + const nextIndexStr = "result-" + (index - 1); + const querySel = "li[id$='" + nextIndexStr + "'"; + const nextResult = document.querySelector(querySel); + if (nextResult) { + nextResult.firstChild.focus(); + } + } + } +} + +// Move the cursor down the search list +function selectDown(e) { + if (e.target.id === "search-bar") { + const firstResult = document.querySelector("li[id$='result-0']"); + if (firstResult) { + firstResult.firstChild.focus(); + } + } else if (e.target.parentElement.id.startsWith("result-")) { + const index = parseInt(e.target.parentElement.id.substring(7)); + if (!isNaN(index)) { + const nextIndexStr = "result-" + (index + 1); + const querySel = "li[id$='" + nextIndexStr + "'"; + const nextResult = document.querySelector(querySel); + if (nextResult) { + nextResult.firstChild.focus(); + } + } + } +} + +// Search for whatever the user has typed so far +function runSearch(e) { + if (e.target.value === "") { + // On empty string, remove all search results + // Otherwise this may show all results as everything is a "match" + applySearchResults([]); + } else { + const tokens = e.target.value.split(" "); + const moddedTokens = tokens.map(function (token) { + // "*" + token + "*" + return token; + }) + const searchTerm = moddedTokens.join(" "); + const searchResults = idx.search(searchTerm); + const mapResults = searchResults.map(function (result) { + const resultUrl = docMap.get(result.ref); + return { name: result.ref, url: resultUrl }; + }) + + applySearchResults(mapResults); + } + +} + +// After a search, modify the search dropdown to contain the search results +function applySearchResults(results) { + const dropdown = document.querySelector("div[id$='search-dropdown'] > .dropdown-content.show"); + if (dropdown) { + //Remove each child + while (dropdown.firstChild) { + dropdown.removeChild(dropdown.firstChild); + } + + //Add each result as an element in the list + results.forEach(function (result, i) { + const elem = document.createElement("li"); + elem.setAttribute("class", "dropdown-item"); + elem.setAttribute("id", "result-" + i); + + const elemLink = document.createElement("a"); + elemLink.setAttribute("title", result.name); + elemLink.setAttribute("href", result.url); + elemLink.setAttribute("class", "dropdown-item-link"); + + const elemLinkText = document.createElement("span"); + elemLinkText.setAttribute("class", "dropdown-item-link-text"); + elemLinkText.innerHTML = result.name; + + elemLink.appendChild(elemLinkText); + elem.appendChild(elemLink); + dropdown.appendChild(elem); + }); + } +} + +// Close the dropdown if the user clicks (only) outside of it +function closeDropdownSearch(e) { + // Check if where we're clicking is the search dropdown + if (e.target.id !== "search-bar") { + const dropdown = document.querySelector("div[id$='search-dropdown'] > .dropdown-content.show"); + if (dropdown) { + dropdown.classList.remove("show"); + document.documentElement.removeEventListener("click", closeDropdownSearch); + } + } +} diff --git a/js/version-selector.js b/js/version-selector.js new file mode 100644 index 00000000..0c3e5855 --- /dev/null +++ b/js/version-selector.js @@ -0,0 +1,36 @@ +/* When the user clicks on the navigation Documentation button, + * toggle between hiding and showing the dropdown content. + */ +function displayToggleVersion(e) { + e.preventDefault(); + e.stopPropagation(); + // Calling close func. in case we're clicking another dropdown with one opened + closeDropdownVersion(e); + const parent = e.target.closest("div[id$='version-dropdown']"); + if (parent) { + const dropdown = parent.querySelector("#version-dropdown-content"); + if (dropdown) { + dropdown.classList.toggle("show"); + if (dropdown.classList.contains("show")) { + document.documentElement.addEventListener("click", closeDropdownVersion); + } + else { + document.documentElement.removeEventListener("click", closeDropdownVersion); + } + } + } +} + +// Close the dropdown if the user clicks (only) outside of it +function closeDropdownVersion(e) { + const dropdown = document.querySelector("div[id$='version-dropdown'] > .dropdown-content.show"); + if (dropdown) { + const currentTarget = e.currentTarget || {}; + const currentTargetParent = currentTarget.closest("div[id$='version-dropdown']"); + const dropdownParent = dropdown.closest("div[id$='version-dropdown']"); + if (currentTargetParent !== dropdownParent) { + dropdown.classList.remove("show"); + } + document.documentElement.removeEventListener("click", closeDropdownVersion); + } +} diff --git a/lunr/LICENSE b/lunr/LICENSE new file mode 100644 index 00000000..8a12a69b --- /dev/null +++ b/lunr/LICENSE @@ -0,0 +1,20 @@ + +Copyright (C) 2013 by Oliver Nightingale + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/lunr/lunr.js b/lunr/lunr.js new file mode 100644 index 00000000..fc329593 --- /dev/null +++ b/lunr/lunr.js @@ -0,0 +1,3475 @@ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ + +; (function () { + + /** + * A convenience function for configuring and constructing + * a new lunr Index. + * + * A lunr.Builder instance is created and the pipeline setup + * with a trimmer, stop word filter and stemmer. + * + * This builder object is yielded to the configuration function + * that is passed as a parameter, allowing the list of fields + * and other builder parameters to be customised. + * + * All documents _must_ be added within the passed config function. + * + * @example + * var idx = lunr(function () { + * this.field('title') + * this.field('body') + * this.ref('id') + * + * documents.forEach(function (doc) { + * this.add(doc) + * }, this) + * }) + * + * @see {@link lunr.Builder} + * @see {@link lunr.Pipeline} + * @see {@link lunr.trimmer} + * @see {@link lunr.stopWordFilter} + * @see {@link lunr.stemmer} + * @namespace {function} lunr + */ + var lunr = function (config) { + var builder = new lunr.Builder + + builder.pipeline.add( + lunr.trimmer, + lunr.stopWordFilter, + lunr.stemmer + ) + + builder.searchPipeline.add( + lunr.stemmer + ) + + config.call(builder, builder) + return builder.build() + } + + lunr.version = "2.3.9" + /*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * A namespace containing utils for the rest of the lunr library + * @namespace lunr.utils + */ + lunr.utils = {} + + /** + * Print a warning message to the console. + * + * @param {String} message The message to be printed. + * @memberOf lunr.utils + * @function + */ + lunr.utils.warn = (function (global) { + /* eslint-disable no-console */ + return function (message) { + if (global.console && console.warn) { + console.warn(message) + } + } + /* eslint-enable no-console */ + })(this) + + /** + * Convert an object to a string. + * + * In the case of `null` and `undefined` the function returns + * the empty string, in all other cases the result of calling + * `toString` on the passed object is returned. + * + * @param {Any} obj The object to convert to a string. + * @return {String} string representation of the passed object. + * @memberOf lunr.utils + */ + lunr.utils.asString = function (obj) { + if (obj === void 0 || obj === null) { + return "" + } else { + return obj.toString() + } + } + + /** + * Clones an object. + * + * Will create a copy of an existing object such that any mutations + * on the copy cannot affect the original. + * + * Only shallow objects are supported, passing a nested object to this + * function will cause a TypeError. + * + * Objects with primitives, and arrays of primitives are supported. + * + * @param {Object} obj The object to clone. + * @return {Object} a clone of the passed object. + * @throws {TypeError} when a nested object is passed. + * @memberOf Utils + */ + lunr.utils.clone = function (obj) { + if (obj === null || obj === undefined) { + return obj + } + + var clone = Object.create(null), + keys = Object.keys(obj) + + for (var i = 0; i < keys.length; i++) { + var key = keys[i], + val = obj[key] + + if (Array.isArray(val)) { + clone[key] = val.slice() + continue + } + + if (typeof val === 'string' || + typeof val === 'number' || + typeof val === 'boolean') { + clone[key] = val + continue + } + + throw new TypeError("clone is not deep and does not support nested objects") + } + + return clone + } + lunr.FieldRef = function (docRef, fieldName, stringValue) { + this.docRef = docRef + this.fieldName = fieldName + this._stringValue = stringValue + } + + lunr.FieldRef.joiner = "/" + + lunr.FieldRef.fromString = function (s) { + var n = s.indexOf(lunr.FieldRef.joiner) + + if (n === -1) { + throw "malformed field ref string" + } + + var fieldRef = s.slice(0, n), + docRef = s.slice(n + 1) + + return new lunr.FieldRef(docRef, fieldRef, s) + } + + lunr.FieldRef.prototype.toString = function () { + if (this._stringValue == undefined) { + this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef + } + + return this._stringValue + } + /*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * A lunr set. + * + * @constructor + */ + lunr.Set = function (elements) { + this.elements = Object.create(null) + + if (elements) { + this.length = elements.length + + for (var i = 0; i < this.length; i++) { + this.elements[elements[i]] = true + } + } else { + this.length = 0 + } + } + + /** + * A complete set that contains all elements. + * + * @static + * @readonly + * @type {lunr.Set} + */ + lunr.Set.complete = { + intersect: function (other) { + return other + }, + + union: function () { + return this + }, + + contains: function () { + return true + } + } + + /** + * An empty set that contains no elements. + * + * @static + * @readonly + * @type {lunr.Set} + */ + lunr.Set.empty = { + intersect: function () { + return this + }, + + union: function (other) { + return other + }, + + contains: function () { + return false + } + } + + /** + * Returns true if this set contains the specified object. + * + * @param {object} object - Object whose presence in this set is to be tested. + * @returns {boolean} - True if this set contains the specified object. + */ + lunr.Set.prototype.contains = function (object) { + return !!this.elements[object] + } + + /** + * Returns a new set containing only the elements that are present in both + * this set and the specified set. + * + * @param {lunr.Set} other - set to intersect with this set. + * @returns {lunr.Set} a new set that is the intersection of this and the specified set. + */ + + lunr.Set.prototype.intersect = function (other) { + var a, b, elements, intersection = [] + + if (other === lunr.Set.complete) { + return this + } + + if (other === lunr.Set.empty) { + return other + } + + if (this.length < other.length) { + a = this + b = other + } else { + a = other + b = this + } + + elements = Object.keys(a.elements) + + for (var i = 0; i < elements.length; i++) { + var element = elements[i] + if (element in b.elements) { + intersection.push(element) + } + } + + return new lunr.Set(intersection) + } + + /** + * Returns a new set combining the elements of this and the specified set. + * + * @param {lunr.Set} other - set to union with this set. + * @return {lunr.Set} a new set that is the union of this and the specified set. + */ + + lunr.Set.prototype.union = function (other) { + if (other === lunr.Set.complete) { + return lunr.Set.complete + } + + if (other === lunr.Set.empty) { + return this + } + + return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements))) + } + /** + * A function to calculate the inverse document frequency for + * a posting. This is shared between the builder and the index + * + * @private + * @param {object} posting - The posting for a given term + * @param {number} documentCount - The total number of documents. + */ + lunr.idf = function (posting, documentCount) { + var documentsWithTerm = 0 + + for (var fieldName in posting) { + if (fieldName == '_index') continue // Ignore the term index, its not a field + documentsWithTerm += Object.keys(posting[fieldName]).length + } + + var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5) + + return Math.log(1 + Math.abs(x)) + } + + /** + * A token wraps a string representation of a token + * as it is passed through the text processing pipeline. + * + * @constructor + * @param {string} [str=''] - The string token being wrapped. + * @param {object} [metadata={}] - Metadata associated with this token. + */ + lunr.Token = function (str, metadata) { + this.str = str || "" + this.metadata = metadata || {} + } + + /** + * Returns the token string that is being wrapped by this object. + * + * @returns {string} + */ + lunr.Token.prototype.toString = function () { + return this.str + } + + /** + * A token update function is used when updating or optionally + * when cloning a token. + * + * @callback lunr.Token~updateFunction + * @param {string} str - The string representation of the token. + * @param {Object} metadata - All metadata associated with this token. + */ + + /** + * Applies the given function to the wrapped string token. + * + * @example + * token.update(function (str, metadata) { + * return str.toUpperCase() + * }) + * + * @param {lunr.Token~updateFunction} fn - A function to apply to the token string. + * @returns {lunr.Token} + */ + lunr.Token.prototype.update = function (fn) { + this.str = fn(this.str, this.metadata) + return this + } + + /** + * Creates a clone of this token. Optionally a function can be + * applied to the cloned token. + * + * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token. + * @returns {lunr.Token} + */ + lunr.Token.prototype.clone = function (fn) { + fn = fn || function (s) { return s } + return new lunr.Token(fn(this.str, this.metadata), this.metadata) + } + /*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * A function for splitting a string into tokens ready to be inserted into + * the search index. Uses `lunr.tokenizer.separator` to split strings, change + * the value of this property to change how strings are split into tokens. + * + * This tokenizer will convert its parameter to a string by calling `toString` and + * then will split this string on the character in `lunr.tokenizer.separator`. + * Arrays will have their elements converted to strings and wrapped in a lunr.Token. + * + * Optional metadata can be passed to the tokenizer, this metadata will be cloned and + * added as metadata to every token that is created from the object to be tokenized. + * + * @static + * @param {?(string|object|object[])} obj - The object to convert into tokens + * @param {?object} metadata - Optional metadata to associate with every token + * @returns {lunr.Token[]} + * @see {@link lunr.Pipeline} + */ + lunr.tokenizer = function (obj, metadata) { + if (obj == null || obj == undefined) { + return [] + } + + if (Array.isArray(obj)) { + return obj.map(function (t) { + return new lunr.Token( + lunr.utils.asString(t).toLowerCase(), + lunr.utils.clone(metadata) + ) + }) + } + + var str = obj.toString().toLowerCase(), + len = str.length, + tokens = [] + + for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) { + var char = str.charAt(sliceEnd), + sliceLength = sliceEnd - sliceStart + + if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) { + + if (sliceLength > 0) { + var tokenMetadata = lunr.utils.clone(metadata) || {} + tokenMetadata["position"] = [sliceStart, sliceLength] + tokenMetadata["index"] = tokens.length + + tokens.push( + new lunr.Token( + str.slice(sliceStart, sliceEnd), + tokenMetadata + ) + ) + } + + sliceStart = sliceEnd + 1 + } + + } + + return tokens + } + + /** + * The separator used to split a string into tokens. Override this property to change the behaviour of + * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens. + * + * @static + * @see lunr.tokenizer + */ + lunr.tokenizer.separator = /[\s\-]+/ + /*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * lunr.Pipelines maintain an ordered list of functions to be applied to all + * tokens in documents entering the search index and queries being ran against + * the index. + * + * An instance of lunr.Index created with the lunr shortcut will contain a + * pipeline with a stop word filter and an English language stemmer. Extra + * functions can be added before or after either of these functions or these + * default functions can be removed. + * + * When run the pipeline will call each function in turn, passing a token, the + * index of that token in the original list of all tokens and finally a list of + * all the original tokens. + * + * The output of functions in the pipeline will be passed to the next function + * in the pipeline. To exclude a token from entering the index the function + * should return undefined, the rest of the pipeline will not be called with + * this token. + * + * For serialisation of pipelines to work, all functions used in an instance of + * a pipeline should be registered with lunr.Pipeline. Registered functions can + * then be loaded. If trying to load a serialised pipeline that uses functions + * that are not registered an error will be thrown. + * + * If not planning on serialising the pipeline then registering pipeline functions + * is not necessary. + * + * @constructor + */ + lunr.Pipeline = function () { + this._stack = [] + } + + lunr.Pipeline.registeredFunctions = Object.create(null) + + /** + * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token + * string as well as all known metadata. A pipeline function can mutate the token string + * or mutate (or add) metadata for a given token. + * + * A pipeline function can indicate that the passed token should be discarded by returning + * null, undefined or an empty string. This token will not be passed to any downstream pipeline + * functions and will not be added to the index. + * + * Multiple tokens can be returned by returning an array of tokens. Each token will be passed + * to any downstream pipeline functions and all will returned tokens will be added to the index. + * + * Any number of pipeline functions may be chained together using a lunr.Pipeline. + * + * @interface lunr.PipelineFunction + * @param {lunr.Token} token - A token from the document being processed. + * @param {number} i - The index of this token in the complete list of tokens for this document/field. + * @param {lunr.Token[]} tokens - All tokens for this document/field. + * @returns {(?lunr.Token|lunr.Token[])} + */ + + /** + * Register a function with the pipeline. + * + * Functions that are used in the pipeline should be registered if the pipeline + * needs to be serialised, or a serialised pipeline needs to be loaded. + * + * Registering a function does not add it to a pipeline, functions must still be + * added to instances of the pipeline for them to be used when running a pipeline. + * + * @param {lunr.PipelineFunction} fn - The function to check for. + * @param {String} label - The label to register this function with + */ + lunr.Pipeline.registerFunction = function (fn, label) { + if (label in this.registeredFunctions) { + lunr.utils.warn('Overwriting existing registered function: ' + label) + } + + fn.label = label + lunr.Pipeline.registeredFunctions[fn.label] = fn + } + + /** + * Warns if the function is not registered as a Pipeline function. + * + * @param {lunr.PipelineFunction} fn - The function to check for. + * @private + */ + lunr.Pipeline.warnIfFunctionNotRegistered = function (fn) { + var isRegistered = fn.label && (fn.label in this.registeredFunctions) + + if (!isRegistered) { + lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\n', fn) + } + } + + /** + * Loads a previously serialised pipeline. + * + * All functions to be loaded must already be registered with lunr.Pipeline. + * If any function from the serialised data has not been registered then an + * error will be thrown. + * + * @param {Object} serialised - The serialised pipeline to load. + * @returns {lunr.Pipeline} + */ + lunr.Pipeline.load = function (serialised) { + var pipeline = new lunr.Pipeline + + serialised.forEach(function (fnName) { + var fn = lunr.Pipeline.registeredFunctions[fnName] + + if (fn) { + pipeline.add(fn) + } else { + throw new Error('Cannot load unregistered function: ' + fnName) + } + }) + + return pipeline + } + + /** + * Adds new functions to the end of the pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline. + */ + lunr.Pipeline.prototype.add = function () { + var fns = Array.prototype.slice.call(arguments) + + fns.forEach(function (fn) { + lunr.Pipeline.warnIfFunctionNotRegistered(fn) + this._stack.push(fn) + }, this) + } + + /** + * Adds a single function after a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ + lunr.Pipeline.prototype.after = function (existingFn, newFn) { + lunr.Pipeline.warnIfFunctionNotRegistered(newFn) + + var pos = this._stack.indexOf(existingFn) + if (pos == -1) { + throw new Error('Cannot find existingFn') + } + + pos = pos + 1 + this._stack.splice(pos, 0, newFn) + } + + /** + * Adds a single function before a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ + lunr.Pipeline.prototype.before = function (existingFn, newFn) { + lunr.Pipeline.warnIfFunctionNotRegistered(newFn) + + var pos = this._stack.indexOf(existingFn) + if (pos == -1) { + throw new Error('Cannot find existingFn') + } + + this._stack.splice(pos, 0, newFn) + } + + /** + * Removes a function from the pipeline. + * + * @param {lunr.PipelineFunction} fn The function to remove from the pipeline. + */ + lunr.Pipeline.prototype.remove = function (fn) { + var pos = this._stack.indexOf(fn) + if (pos == -1) { + return + } + + this._stack.splice(pos, 1) + } + + /** + * Runs the current list of functions that make up the pipeline against the + * passed tokens. + * + * @param {Array} tokens The tokens to run through the pipeline. + * @returns {Array} + */ + lunr.Pipeline.prototype.run = function (tokens) { + var stackLength = this._stack.length + + for (var i = 0; i < stackLength; i++) { + var fn = this._stack[i] + var memo = [] + + for (var j = 0; j < tokens.length; j++) { + var result = fn(tokens[j], j, tokens) + + if (result === null || result === void 0 || result === '') continue + + if (Array.isArray(result)) { + for (var k = 0; k < result.length; k++) { + memo.push(result[k]) + } + } else { + memo.push(result) + } + } + + tokens = memo + } + + return tokens + } + + /** + * Convenience method for passing a string through a pipeline and getting + * strings out. This method takes care of wrapping the passed string in a + * token and mapping the resulting tokens back to strings. + * + * @param {string} str - The string to pass through the pipeline. + * @param {?object} metadata - Optional metadata to associate with the token + * passed to the pipeline. + * @returns {string[]} + */ + lunr.Pipeline.prototype.runString = function (str, metadata) { + var token = new lunr.Token(str, metadata) + + return this.run([token]).map(function (t) { + return t.toString() + }) + } + + /** + * Resets the pipeline by removing any existing processors. + * + */ + lunr.Pipeline.prototype.reset = function () { + this._stack = [] + } + + /** + * Returns a representation of the pipeline ready for serialisation. + * + * Logs a warning if the function has not been registered. + * + * @returns {Array} + */ + lunr.Pipeline.prototype.toJSON = function () { + return this._stack.map(function (fn) { + lunr.Pipeline.warnIfFunctionNotRegistered(fn) + + return fn.label + }) + } + /*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * A vector is used to construct the vector space of documents and queries. These + * vectors support operations to determine the similarity between two documents or + * a document and a query. + * + * Normally no parameters are required for initializing a vector, but in the case of + * loading a previously dumped vector the raw elements can be provided to the constructor. + * + * For performance reasons vectors are implemented with a flat array, where an elements + * index is immediately followed by its value. E.g. [index, value, index, value]. This + * allows the underlying array to be as sparse as possible and still offer decent + * performance when being used for vector calculations. + * + * @constructor + * @param {Number[]} [elements] - The flat list of element index and element value pairs. + */ + lunr.Vector = function (elements) { + this._magnitude = 0 + this.elements = elements || [] + } + + + /** + * Calculates the position within the vector to insert a given index. + * + * This is used internally by insert and upsert. If there are duplicate indexes then + * the position is returned as if the value for that index were to be updated, but it + * is the callers responsibility to check whether there is a duplicate at that index + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @returns {Number} + */ + lunr.Vector.prototype.positionForIndex = function (index) { + // For an empty vector the tuple can be inserted at the beginning + if (this.elements.length == 0) { + return 0 + } + + var start = 0, + end = this.elements.length / 2, + sliceLength = end - start, + pivotPoint = Math.floor(sliceLength / 2), + pivotIndex = this.elements[pivotPoint * 2] + + while (sliceLength > 1) { + if (pivotIndex < index) { + start = pivotPoint + } + + if (pivotIndex > index) { + end = pivotPoint + } + + if (pivotIndex == index) { + break + } + + sliceLength = end - start + pivotPoint = start + Math.floor(sliceLength / 2) + pivotIndex = this.elements[pivotPoint * 2] + } + + if (pivotIndex == index) { + return pivotPoint * 2 + } + + if (pivotIndex > index) { + return pivotPoint * 2 + } + + if (pivotIndex < index) { + return (pivotPoint + 1) * 2 + } + } + + /** + * Inserts an element at an index within the vector. + * + * Does not allow duplicates, will throw an error if there is already an entry + * for this index. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + */ + lunr.Vector.prototype.insert = function (insertIdx, val) { + this.upsert(insertIdx, val, function () { + throw "duplicate index" + }) + } + + /** + * Inserts or updates an existing index within the vector. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + * @param {function} fn - A function that is called for updates, the existing value and the + * requested value are passed as arguments + */ + lunr.Vector.prototype.upsert = function (insertIdx, val, fn) { + this._magnitude = 0 + var position = this.positionForIndex(insertIdx) + + if (this.elements[position] == insertIdx) { + this.elements[position + 1] = fn(this.elements[position + 1], val) + } else { + this.elements.splice(position, 0, insertIdx, val) + } + } + + /** + * Calculates the magnitude of this vector. + * + * @returns {Number} + */ + lunr.Vector.prototype.magnitude = function () { + if (this._magnitude) return this._magnitude + + var sumOfSquares = 0, + elementsLength = this.elements.length + + for (var i = 1; i < elementsLength; i += 2) { + var val = this.elements[i] + sumOfSquares += val * val + } + + return this._magnitude = Math.sqrt(sumOfSquares) + } + + /** + * Calculates the dot product of this vector and another vector. + * + * @param {lunr.Vector} otherVector - The vector to compute the dot product with. + * @returns {Number} + */ + lunr.Vector.prototype.dot = function (otherVector) { + var dotProduct = 0, + a = this.elements, b = otherVector.elements, + aLen = a.length, bLen = b.length, + aVal = 0, bVal = 0, + i = 0, j = 0 + + while (i < aLen && j < bLen) { + aVal = a[i], bVal = b[j] + if (aVal < bVal) { + i += 2 + } else if (aVal > bVal) { + j += 2 + } else if (aVal == bVal) { + dotProduct += a[i + 1] * b[j + 1] + i += 2 + j += 2 + } + } + + return dotProduct + } + + /** + * Calculates the similarity between this vector and another vector. + * + * @param {lunr.Vector} otherVector - The other vector to calculate the + * similarity with. + * @returns {Number} + */ + lunr.Vector.prototype.similarity = function (otherVector) { + return this.dot(otherVector) / this.magnitude() || 0 + } + + /** + * Converts the vector to an array of the elements within the vector. + * + * @returns {Number[]} + */ + lunr.Vector.prototype.toArray = function () { + var output = new Array(this.elements.length / 2) + + for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) { + output[j] = this.elements[i] + } + + return output + } + + /** + * A JSON serializable representation of the vector. + * + * @returns {Number[]} + */ + lunr.Vector.prototype.toJSON = function () { + return this.elements + } + /* eslint-disable */ + /*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ + + /** + * lunr.stemmer is an english language stemmer, this is a JavaScript + * implementation of the PorterStemmer taken from http://tartarus.org/~martin + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token - The string to stem + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + * @function + */ + lunr.stemmer = (function () { + var step2list = { + "ational": "ate", + "tional": "tion", + "enci": "ence", + "anci": "ance", + "izer": "ize", + "bli": "ble", + "alli": "al", + "entli": "ent", + "eli": "e", + "ousli": "ous", + "ization": "ize", + "ation": "ate", + "ator": "ate", + "alism": "al", + "iveness": "ive", + "fulness": "ful", + "ousness": "ous", + "aliti": "al", + "iviti": "ive", + "biliti": "ble", + "logi": "log" + }, + + step3list = { + "icate": "ic", + "ative": "", + "alize": "al", + "iciti": "ic", + "ical": "ic", + "ful": "", + "ness": "" + }, + + c = "[^aeiou]", // consonant + v = "[aeiouy]", // vowel + C = c + "[^aeiouy]*", // consonant sequence + V = v + "[aeiou]*", // vowel sequence + + mgr0 = "^(" + C + ")?" + V + C, // [C]VC... is m>0 + meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$", // [C]VC[V] is m=1 + mgr1 = "^(" + C + ")?" + V + C + V + C, // [C]VCVC... is m>1 + s_v = "^(" + C + ")?" + v; // vowel in stem + + var re_mgr0 = new RegExp(mgr0); + var re_mgr1 = new RegExp(mgr1); + var re_meq1 = new RegExp(meq1); + var re_s_v = new RegExp(s_v); + + var re_1a = /^(.+?)(ss|i)es$/; + var re2_1a = /^(.+?)([^s])s$/; + var re_1b = /^(.+?)eed$/; + var re2_1b = /^(.+?)(ed|ing)$/; + var re_1b_2 = /.$/; + var re2_1b_2 = /(at|bl|iz)$/; + var re3_1b_2 = new RegExp("([^aeiouylsz])\\1$"); + var re4_1b_2 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var re_1c = /^(.+?[^aeiou])y$/; + var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + + var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + + var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + var re2_4 = /^(.+?)(s|t)(ion)$/; + + var re_5 = /^(.+?)e$/; + var re_5_1 = /ll$/; + var re3_5 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var porterStemmer = function porterStemmer(w) { + var stem, + suffix, + firstch, + re, + re2, + re3, + re4; + + if (w.length < 3) { return w; } + + firstch = w.substr(0, 1); + if (firstch == "y") { + w = firstch.toUpperCase() + w.substr(1); + } + + // Step 1a + re = re_1a + re2 = re2_1a; + + if (re.test(w)) { w = w.replace(re, "$1$2"); } + else if (re2.test(w)) { w = w.replace(re2, "$1$2"); } + + // Step 1b + re = re_1b; + re2 = re2_1b; + if (re.test(w)) { + var fp = re.exec(w); + re = re_mgr0; + if (re.test(fp[1])) { + re = re_1b_2; + w = w.replace(re, ""); + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = re_s_v; + if (re2.test(stem)) { + w = stem; + re2 = re2_1b_2; + re3 = re3_1b_2; + re4 = re4_1b_2; + if (re2.test(w)) { w = w + "e"; } + else if (re3.test(w)) { re = re_1b_2; w = w.replace(re, ""); } + else if (re4.test(w)) { w = w + "e"; } + } + } + + // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say) + re = re_1c; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + w = stem + "i"; + } + + // Step 2 + re = re_2; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step2list[suffix]; + } + } + + // Step 3 + re = re_3; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step3list[suffix]; + } + } + + // Step 4 + re = re_4; + re2 = re2_4; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + if (re.test(stem)) { + w = stem; + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = re_mgr1; + if (re2.test(stem)) { + w = stem; + } + } + + // Step 5 + re = re_5; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + re2 = re_meq1; + re3 = re3_5; + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) { + w = stem; + } + } + + re = re_5_1; + re2 = re_mgr1; + if (re.test(w) && re2.test(w)) { + re = re_1b_2; + w = w.replace(re, ""); + } + + // and turn initial Y back to y + + if (firstch == "y") { + w = firstch.toLowerCase() + w.substr(1); + } + + return w; + }; + + return function (token) { + return token.update(porterStemmer); + } + })(); + + lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer') + /*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * lunr.generateStopWordFilter builds a stopWordFilter function from the provided + * list of stop words. + * + * The built in lunr.stopWordFilter is built using this generator and can be used + * to generate custom stopWordFilters for applications or non English languages. + * + * @function + * @param {Array} token The token to pass through the filter + * @returns {lunr.PipelineFunction} + * @see lunr.Pipeline + * @see lunr.stopWordFilter + */ + lunr.generateStopWordFilter = function (stopWords) { + var words = stopWords.reduce(function (memo, stopWord) { + memo[stopWord] = stopWord + return memo + }, {}) + + return function (token) { + if (token && words[token.toString()] !== token.toString()) return token + } + } + + /** + * lunr.stopWordFilter is an English language stop word list filter, any words + * contained in the list will not be passed through the filter. + * + * This is intended to be used in the Pipeline. If the token does not pass the + * filter then undefined will be returned. + * + * @function + * @implements {lunr.PipelineFunction} + * @params {lunr.Token} token - A token to check for being a stop word. + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + */ + lunr.stopWordFilter = lunr.generateStopWordFilter([ + 'a', + 'able', + 'about', + 'across', + 'after', + 'all', + 'almost', + 'also', + 'am', + 'among', + 'an', + 'and', + 'any', + 'are', + 'as', + 'at', + 'be', + 'because', + 'been', + 'but', + 'by', + 'can', + 'cannot', + 'could', + 'dear', + 'did', + 'do', + 'does', + 'either', + 'else', + 'ever', + 'every', + 'for', + 'from', + 'get', + 'got', + 'had', + 'has', + 'have', + 'he', + 'her', + 'hers', + 'him', + 'his', + 'how', + 'however', + 'i', + 'if', + 'in', + 'into', + 'is', + 'it', + 'its', + 'just', + 'least', + 'let', + 'like', + 'likely', + 'may', + 'me', + 'might', + 'most', + 'must', + 'my', + 'neither', + 'no', + 'nor', + 'not', + 'of', + 'off', + 'often', + 'on', + 'only', + 'or', + 'other', + 'our', + 'own', + 'rather', + 'said', + 'say', + 'says', + 'she', + 'should', + 'since', + 'so', + 'some', + 'than', + 'that', + 'the', + 'their', + 'them', + 'then', + 'there', + 'these', + 'they', + 'this', + 'tis', + 'to', + 'too', + 'twas', + 'us', + 'wants', + 'was', + 'we', + 'were', + 'what', + 'when', + 'where', + 'which', + 'while', + 'who', + 'whom', + 'why', + 'will', + 'with', + 'would', + 'yet', + 'you', + 'your' + ]) + + lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter') + /*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * lunr.trimmer is a pipeline function for trimming non word + * characters from the beginning and end of tokens before they + * enter the index. + * + * This implementation may not work correctly for non latin + * characters and should either be removed or adapted for use + * with languages with non-latin characters. + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token The token to pass through the filter + * @returns {lunr.Token} + * @see lunr.Pipeline + */ + lunr.trimmer = function (token) { + return token.update(function (s) { + return s.replace(/^\W+/, '').replace(/\W+$/, '') + }) + } + + lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer') + /*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * A token set is used to store the unique list of all tokens + * within an index. Token sets are also used to represent an + * incoming query to the index, this query token set and index + * token set are then intersected to find which tokens to look + * up in the inverted index. + * + * A token set can hold multiple tokens, as in the case of the + * index token set, or it can hold a single token as in the + * case of a simple query token set. + * + * Additionally token sets are used to perform wildcard matching. + * Leading, contained and trailing wildcards are supported, and + * from this edit distance matching can also be provided. + * + * Token sets are implemented as a minimal finite state automata, + * where both common prefixes and suffixes are shared between tokens. + * This helps to reduce the space used for storing the token set. + * + * @constructor + */ + lunr.TokenSet = function () { + this.final = false + this.edges = {} + this.id = lunr.TokenSet._nextId + lunr.TokenSet._nextId += 1 + } + + /** + * Keeps track of the next, auto increment, identifier to assign + * to a new tokenSet. + * + * TokenSets require a unique identifier to be correctly minimised. + * + * @private + */ + lunr.TokenSet._nextId = 1 + + /** + * Creates a TokenSet instance from the given sorted array of words. + * + * @param {String[]} arr - A sorted array of strings to create the set from. + * @returns {lunr.TokenSet} + * @throws Will throw an error if the input array is not sorted. + */ + lunr.TokenSet.fromArray = function (arr) { + var builder = new lunr.TokenSet.Builder + + for (var i = 0, len = arr.length; i < len; i++) { + builder.insert(arr[i]) + } + + builder.finish() + return builder.root + } + + /** + * Creates a token set from a query clause. + * + * @private + * @param {Object} clause - A single clause from lunr.Query. + * @param {string} clause.term - The query clause term. + * @param {number} [clause.editDistance] - The optional edit distance for the term. + * @returns {lunr.TokenSet} + */ + lunr.TokenSet.fromClause = function (clause) { + if ('editDistance' in clause) { + return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance) + } else { + return lunr.TokenSet.fromString(clause.term) + } + } + + /** + * Creates a token set representing a single string with a specified + * edit distance. + * + * Insertions, deletions, substitutions and transpositions are each + * treated as an edit distance of 1. + * + * Increasing the allowed edit distance will have a dramatic impact + * on the performance of both creating and intersecting these TokenSets. + * It is advised to keep the edit distance less than 3. + * + * @param {string} str - The string to create the token set from. + * @param {number} editDistance - The allowed edit distance to match. + * @returns {lunr.Vector} + */ + lunr.TokenSet.fromFuzzyString = function (str, editDistance) { + var root = new lunr.TokenSet + + var stack = [{ + node: root, + editsRemaining: editDistance, + str: str + }] + + while (stack.length) { + var frame = stack.pop() + + // no edit + if (frame.str.length > 0) { + var char = frame.str.charAt(0), + noEditNode + + if (char in frame.node.edges) { + noEditNode = frame.node.edges[char] + } else { + noEditNode = new lunr.TokenSet + frame.node.edges[char] = noEditNode + } + + if (frame.str.length == 1) { + noEditNode.final = true + } + + stack.push({ + node: noEditNode, + editsRemaining: frame.editsRemaining, + str: frame.str.slice(1) + }) + } + + if (frame.editsRemaining == 0) { + continue + } + + // insertion + if ("*" in frame.node.edges) { + var insertionNode = frame.node.edges["*"] + } else { + var insertionNode = new lunr.TokenSet + frame.node.edges["*"] = insertionNode + } + + if (frame.str.length == 0) { + insertionNode.final = true + } + + stack.push({ + node: insertionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str + }) + + // deletion + // can only do a deletion if we have enough edits remaining + // and if there are characters left to delete in the string + if (frame.str.length > 1) { + stack.push({ + node: frame.node, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }) + } + + // deletion + // just removing the last character from the str + if (frame.str.length == 1) { + frame.node.final = true + } + + // substitution + // can only do a substitution if we have enough edits remaining + // and if there are characters left to substitute + if (frame.str.length >= 1) { + if ("*" in frame.node.edges) { + var substitutionNode = frame.node.edges["*"] + } else { + var substitutionNode = new lunr.TokenSet + frame.node.edges["*"] = substitutionNode + } + + if (frame.str.length == 1) { + substitutionNode.final = true + } + + stack.push({ + node: substitutionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }) + } + + // transposition + // can only do a transposition if there are edits remaining + // and there are enough characters to transpose + if (frame.str.length > 1) { + var charA = frame.str.charAt(0), + charB = frame.str.charAt(1), + transposeNode + + if (charB in frame.node.edges) { + transposeNode = frame.node.edges[charB] + } else { + transposeNode = new lunr.TokenSet + frame.node.edges[charB] = transposeNode + } + + if (frame.str.length == 1) { + transposeNode.final = true + } + + stack.push({ + node: transposeNode, + editsRemaining: frame.editsRemaining - 1, + str: charA + frame.str.slice(2) + }) + } + } + + return root + } + + /** + * Creates a TokenSet from a string. + * + * The string may contain one or more wildcard characters (*) + * that will allow wildcard matching when intersecting with + * another TokenSet. + * + * @param {string} str - The string to create a TokenSet from. + * @returns {lunr.TokenSet} + */ + lunr.TokenSet.fromString = function (str) { + var node = new lunr.TokenSet, + root = node + + /* + * Iterates through all characters within the passed string + * appending a node for each character. + * + * When a wildcard character is found then a self + * referencing edge is introduced to continually match + * any number of any characters. + */ + for (var i = 0, len = str.length; i < len; i++) { + var char = str[i], + final = (i == len - 1) + + if (char == "*") { + node.edges[char] = node + node.final = final + + } else { + var next = new lunr.TokenSet + next.final = final + + node.edges[char] = next + node = next + } + } + + return root + } + + /** + * Converts this TokenSet into an array of strings + * contained within the TokenSet. + * + * This is not intended to be used on a TokenSet that + * contains wildcards, in these cases the results are + * undefined and are likely to cause an infinite loop. + * + * @returns {string[]} + */ + lunr.TokenSet.prototype.toArray = function () { + var words = [] + + var stack = [{ + prefix: "", + node: this + }] + + while (stack.length) { + var frame = stack.pop(), + edges = Object.keys(frame.node.edges), + len = edges.length + + if (frame.node.final) { + /* In Safari, at this point the prefix is sometimes corrupted, see: + * https://github.com/olivernn/lunr.js/issues/279 Calling any + * String.prototype method forces Safari to "cast" this string to what + * it's supposed to be, fixing the bug. */ + frame.prefix.charAt(0) + words.push(frame.prefix) + } + + for (var i = 0; i < len; i++) { + var edge = edges[i] + + stack.push({ + prefix: frame.prefix.concat(edge), + node: frame.node.edges[edge] + }) + } + } + + return words + } + + /** + * Generates a string representation of a TokenSet. + * + * This is intended to allow TokenSets to be used as keys + * in objects, largely to aid the construction and minimisation + * of a TokenSet. As such it is not designed to be a human + * friendly representation of the TokenSet. + * + * @returns {string} + */ + lunr.TokenSet.prototype.toString = function () { + // NOTE: Using Object.keys here as this.edges is very likely + // to enter 'hash-mode' with many keys being added + // + // avoiding a for-in loop here as it leads to the function + // being de-optimised (at least in V8). From some simple + // benchmarks the performance is comparable, but allowing + // V8 to optimize may mean easy performance wins in the future. + + if (this._str) { + return this._str + } + + var str = this.final ? '1' : '0', + labels = Object.keys(this.edges).sort(), + len = labels.length + + for (var i = 0; i < len; i++) { + var label = labels[i], + node = this.edges[label] + + str = str + label + node.id + } + + return str + } + + /** + * Returns a new TokenSet that is the intersection of + * this TokenSet and the passed TokenSet. + * + * This intersection will take into account any wildcards + * contained within the TokenSet. + * + * @param {lunr.TokenSet} b - An other TokenSet to intersect with. + * @returns {lunr.TokenSet} + */ + lunr.TokenSet.prototype.intersect = function (b) { + var output = new lunr.TokenSet, + frame = undefined + + var stack = [{ + qNode: b, + output: output, + node: this + }] + + while (stack.length) { + frame = stack.pop() + + // NOTE: As with the #toString method, we are using + // Object.keys and a for loop instead of a for-in loop + // as both of these objects enter 'hash' mode, causing + // the function to be de-optimised in V8 + var qEdges = Object.keys(frame.qNode.edges), + qLen = qEdges.length, + nEdges = Object.keys(frame.node.edges), + nLen = nEdges.length + + for (var q = 0; q < qLen; q++) { + var qEdge = qEdges[q] + + for (var n = 0; n < nLen; n++) { + var nEdge = nEdges[n] + + if (nEdge == qEdge || qEdge == '*') { + var node = frame.node.edges[nEdge], + qNode = frame.qNode.edges[qEdge], + final = node.final && qNode.final, + next = undefined + + if (nEdge in frame.output.edges) { + // an edge already exists for this character + // no need to create a new node, just set the finality + // bit unless this node is already final + next = frame.output.edges[nEdge] + next.final = next.final || final + + } else { + // no edge exists yet, must create one + // set the finality bit and insert it + // into the output + next = new lunr.TokenSet + next.final = final + frame.output.edges[nEdge] = next + } + + stack.push({ + qNode: qNode, + output: next, + node: node + }) + } + } + } + } + + return output + } + lunr.TokenSet.Builder = function () { + this.previousWord = "" + this.root = new lunr.TokenSet + this.uncheckedNodes = [] + this.minimizedNodes = {} + } + + lunr.TokenSet.Builder.prototype.insert = function (word) { + var node, + commonPrefix = 0 + + if (word < this.previousWord) { + throw new Error("Out of order word insertion") + } + + for (var i = 0; i < word.length && i < this.previousWord.length; i++) { + if (word[i] != this.previousWord[i]) break + commonPrefix++ + } + + this.minimize(commonPrefix) + + if (this.uncheckedNodes.length == 0) { + node = this.root + } else { + node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child + } + + for (var i = commonPrefix; i < word.length; i++) { + var nextNode = new lunr.TokenSet, + char = word[i] + + node.edges[char] = nextNode + + this.uncheckedNodes.push({ + parent: node, + char: char, + child: nextNode + }) + + node = nextNode + } + + node.final = true + this.previousWord = word + } + + lunr.TokenSet.Builder.prototype.finish = function () { + this.minimize(0) + } + + lunr.TokenSet.Builder.prototype.minimize = function (downTo) { + for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) { + var node = this.uncheckedNodes[i], + childKey = node.child.toString() + + if (childKey in this.minimizedNodes) { + node.parent.edges[node.char] = this.minimizedNodes[childKey] + } else { + // Cache the key for this node since + // we know it can't change anymore + node.child._str = childKey + + this.minimizedNodes[childKey] = node.child + } + + this.uncheckedNodes.pop() + } + } + /*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * An index contains the built index of all documents and provides a query interface + * to the index. + * + * Usually instances of lunr.Index will not be created using this constructor, instead + * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be + * used to load previously built and serialized indexes. + * + * @constructor + * @param {Object} attrs - The attributes of the built search index. + * @param {Object} attrs.invertedIndex - An index of term/field to document reference. + * @param {Object} attrs.fieldVectors - Field vectors + * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens. + * @param {string[]} attrs.fields - The names of indexed document fields. + * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms. + */ + lunr.Index = function (attrs) { + this.invertedIndex = attrs.invertedIndex + this.fieldVectors = attrs.fieldVectors + this.tokenSet = attrs.tokenSet + this.fields = attrs.fields + this.pipeline = attrs.pipeline + } + + /** + * A result contains details of a document matching a search query. + * @typedef {Object} lunr.Index~Result + * @property {string} ref - The reference of the document this result represents. + * @property {number} score - A number between 0 and 1 representing how similar this document is to the query. + * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match. + */ + + /** + * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple + * query language which itself is parsed into an instance of lunr.Query. + * + * For programmatically building queries it is advised to directly use lunr.Query, the query language + * is best used for human entered text rather than program generated text. + * + * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported + * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello' + * or 'world', though those that contain both will rank higher in the results. + * + * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can + * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding + * wildcards will increase the number of documents that will be found but can also have a negative + * impact on query performance, especially with wildcards at the beginning of a term. + * + * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term + * hello in the title field will match this query. Using a field not present in the index will lead + * to an error being thrown. + * + * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term + * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported + * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2. + * Avoid large values for edit distance to improve query performance. + * + * Each term also supports a presence modifier. By default a term's presence in document is optional, however + * this can be changed to either required or prohibited. For a term's presence to be required in a document the + * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and + * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not + * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'. + * + * To escape special characters the backslash character '\' can be used, this allows searches to include + * characters that would normally be considered modifiers, e.g. `foo\~2` will search for a term "foo~2" instead + * of attempting to apply a boost of 2 to the search term "foo". + * + * @typedef {string} lunr.Index~QueryString + * @example Simple single term query + * hello + * @example Multiple term query + * hello world + * @example term scoped to a field + * title:hello + * @example term with a boost of 10 + * hello^10 + * @example term with an edit distance of 2 + * hello~2 + * @example terms with presence modifiers + * -foo +bar baz + */ + + /** + * Performs a search against the index using lunr query syntax. + * + * Results will be returned sorted by their score, the most relevant results + * will be returned first. For details on how the score is calculated, please see + * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}. + * + * For more programmatic querying use lunr.Index#query. + * + * @param {lunr.Index~QueryString} queryString - A string containing a lunr query. + * @throws {lunr.QueryParseError} If the passed query string cannot be parsed. + * @returns {lunr.Index~Result[]} + */ + lunr.Index.prototype.search = function (queryString) { + return this.query(function (query) { + var parser = new lunr.QueryParser(queryString, query) + parser.parse() + }) + } + + /** + * A query builder callback provides a query object to be used to express + * the query to perform on the index. + * + * @callback lunr.Index~queryBuilder + * @param {lunr.Query} query - The query object to build up. + * @this lunr.Query + */ + + /** + * Performs a query against the index using the yielded lunr.Query object. + * + * If performing programmatic queries against the index, this method is preferred + * over lunr.Index#search so as to avoid the additional query parsing overhead. + * + * A query object is yielded to the supplied function which should be used to + * express the query to be run against the index. + * + * Note that although this function takes a callback parameter it is _not_ an + * asynchronous operation, the callback is just yielded a query object to be + * customized. + * + * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query. + * @returns {lunr.Index~Result[]} + */ + lunr.Index.prototype.query = function (fn) { + // for each query clause + // * process terms + // * expand terms from token set + // * find matching documents and metadata + // * get document vectors + // * score documents + + var query = new lunr.Query(this.fields), + matchingFields = Object.create(null), + queryVectors = Object.create(null), + termFieldCache = Object.create(null), + requiredMatches = Object.create(null), + prohibitedMatches = Object.create(null) + + /* + * To support field level boosts a query vector is created per + * field. An empty vector is eagerly created to support negated + * queries. + */ + for (var i = 0; i < this.fields.length; i++) { + queryVectors[this.fields[i]] = new lunr.Vector + } + + fn.call(query, query) + + for (var i = 0; i < query.clauses.length; i++) { + /* + * Unless the pipeline has been disabled for this term, which is + * the case for terms with wildcards, we need to pass the clause + * term through the search pipeline. A pipeline returns an array + * of processed terms. Pipeline functions may expand the passed + * term, which means we may end up performing multiple index lookups + * for a single query term. + */ + var clause = query.clauses[i], + terms = null, + clauseMatches = lunr.Set.empty + + if (clause.usePipeline) { + terms = this.pipeline.runString(clause.term, { + fields: clause.fields + }) + } else { + terms = [clause.term] + } + + for (var m = 0; m < terms.length; m++) { + var term = terms[m] + + /* + * Each term returned from the pipeline needs to use the same query + * clause object, e.g. the same boost and or edit distance. The + * simplest way to do this is to re-use the clause object but mutate + * its term property. + */ + clause.term = term + + /* + * From the term in the clause we create a token set which will then + * be used to intersect the indexes token set to get a list of terms + * to lookup in the inverted index + */ + var termTokenSet = lunr.TokenSet.fromClause(clause), + expandedTerms = this.tokenSet.intersect(termTokenSet).toArray() + + /* + * If a term marked as required does not exist in the tokenSet it is + * impossible for the search to return any matches. We set all the field + * scoped required matches set to empty and stop examining any further + * clauses. + */ + if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k] + requiredMatches[field] = lunr.Set.empty + } + + break + } + + for (var j = 0; j < expandedTerms.length; j++) { + /* + * For each term get the posting and termIndex, this is required for + * building the query vector. + */ + var expandedTerm = expandedTerms[j], + posting = this.invertedIndex[expandedTerm], + termIndex = posting._index + + for (var k = 0; k < clause.fields.length; k++) { + /* + * For each field that this query term is scoped by (by default + * all fields are in scope) we need to get all the document refs + * that have this term in that field. + * + * The posting is the entry in the invertedIndex for the matching + * term from above. + */ + var field = clause.fields[k], + fieldPosting = posting[field], + matchingDocumentRefs = Object.keys(fieldPosting), + termField = expandedTerm + "/" + field, + matchingDocumentsSet = new lunr.Set(matchingDocumentRefs) + + /* + * if the presence of this term is required ensure that the matching + * documents are added to the set of required matches for this clause. + * + */ + if (clause.presence == lunr.Query.presence.REQUIRED) { + clauseMatches = clauseMatches.union(matchingDocumentsSet) + + if (requiredMatches[field] === undefined) { + requiredMatches[field] = lunr.Set.complete + } + } + + /* + * if the presence of this term is prohibited ensure that the matching + * documents are added to the set of prohibited matches for this field, + * creating that set if it does not yet exist. + */ + if (clause.presence == lunr.Query.presence.PROHIBITED) { + if (prohibitedMatches[field] === undefined) { + prohibitedMatches[field] = lunr.Set.empty + } + + prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet) + + /* + * Prohibited matches should not be part of the query vector used for + * similarity scoring and no metadata should be extracted so we continue + * to the next field + */ + continue + } + + /* + * The query field vector is populated using the termIndex found for + * the term and a unit value with the appropriate boost applied. + * Using upsert because there could already be an entry in the vector + * for the term we are working with. In that case we just add the scores + * together. + */ + queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b }) + + /** + * If we've already seen this term, field combo then we've already collected + * the matching documents and metadata, no need to go through all that again + */ + if (termFieldCache[termField]) { + continue + } + + for (var l = 0; l < matchingDocumentRefs.length; l++) { + /* + * All metadata for this term/field/document triple + * are then extracted and collected into an instance + * of lunr.MatchData ready to be returned in the query + * results + */ + var matchingDocumentRef = matchingDocumentRefs[l], + matchingFieldRef = new lunr.FieldRef(matchingDocumentRef, field), + metadata = fieldPosting[matchingDocumentRef], + fieldMatch + + if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) { + matchingFields[matchingFieldRef] = new lunr.MatchData(expandedTerm, field, metadata) + } else { + fieldMatch.add(expandedTerm, field, metadata) + } + + } + + termFieldCache[termField] = true + } + } + } + + /** + * If the presence was required we need to update the requiredMatches field sets. + * We do this after all fields for the term have collected their matches because + * the clause terms presence is required in _any_ of the fields not _all_ of the + * fields. + */ + if (clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k] + requiredMatches[field] = requiredMatches[field].intersect(clauseMatches) + } + } + } + + /** + * Need to combine the field scoped required and prohibited + * matching documents into a global set of required and prohibited + * matches + */ + var allRequiredMatches = lunr.Set.complete, + allProhibitedMatches = lunr.Set.empty + + for (var i = 0; i < this.fields.length; i++) { + var field = this.fields[i] + + if (requiredMatches[field]) { + allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field]) + } + + if (prohibitedMatches[field]) { + allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field]) + } + } + + var matchingFieldRefs = Object.keys(matchingFields), + results = [], + matches = Object.create(null) + + /* + * If the query is negated (contains only prohibited terms) + * we need to get _all_ fieldRefs currently existing in the + * index. This is only done when we know that the query is + * entirely prohibited terms to avoid any cost of getting all + * fieldRefs unnecessarily. + * + * Additionally, blank MatchData must be created to correctly + * populate the results. + */ + if (query.isNegated()) { + matchingFieldRefs = Object.keys(this.fieldVectors) + + for (var i = 0; i < matchingFieldRefs.length; i++) { + var matchingFieldRef = matchingFieldRefs[i] + var fieldRef = lunr.FieldRef.fromString(matchingFieldRef) + matchingFields[matchingFieldRef] = new lunr.MatchData + } + } + + for (var i = 0; i < matchingFieldRefs.length; i++) { + /* + * Currently we have document fields that match the query, but we + * need to return documents. The matchData and scores are combined + * from multiple fields belonging to the same document. + * + * Scores are calculated by field, using the query vectors created + * above, and combined into a final document score using addition. + */ + var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]), + docRef = fieldRef.docRef + + if (!allRequiredMatches.contains(docRef)) { + continue + } + + if (allProhibitedMatches.contains(docRef)) { + continue + } + + var fieldVector = this.fieldVectors[fieldRef], + score = queryVectors[fieldRef.fieldName].similarity(fieldVector), + docMatch + + if ((docMatch = matches[docRef]) !== undefined) { + docMatch.score += score + docMatch.matchData.combine(matchingFields[fieldRef]) + } else { + var match = { + ref: docRef, + score: score, + matchData: matchingFields[fieldRef] + } + matches[docRef] = match + results.push(match) + } + } + + /* + * Sort the results objects by score, highest first. + */ + return results.sort(function (a, b) { + return b.score - a.score + }) + } + + /** + * Prepares the index for JSON serialization. + * + * The schema for this JSON blob will be described in a + * separate JSON schema file. + * + * @returns {Object} + */ + lunr.Index.prototype.toJSON = function () { + var invertedIndex = Object.keys(this.invertedIndex) + .sort() + .map(function (term) { + return [term, this.invertedIndex[term]] + }, this) + + var fieldVectors = Object.keys(this.fieldVectors) + .map(function (ref) { + return [ref, this.fieldVectors[ref].toJSON()] + }, this) + + return { + version: lunr.version, + fields: this.fields, + fieldVectors: fieldVectors, + invertedIndex: invertedIndex, + pipeline: this.pipeline.toJSON() + } + } + + /** + * Loads a previously serialized lunr.Index + * + * @param {Object} serializedIndex - A previously serialized lunr.Index + * @returns {lunr.Index} + */ + lunr.Index.load = function (serializedIndex) { + var attrs = {}, + fieldVectors = {}, + serializedVectors = serializedIndex.fieldVectors, + invertedIndex = Object.create(null), + serializedInvertedIndex = serializedIndex.invertedIndex, + tokenSetBuilder = new lunr.TokenSet.Builder, + pipeline = lunr.Pipeline.load(serializedIndex.pipeline) + + if (serializedIndex.version != lunr.version) { + lunr.utils.warn("Version mismatch when loading serialised index. Current version of lunr '" + lunr.version + "' does not match serialized index '" + serializedIndex.version + "'") + } + + for (var i = 0; i < serializedVectors.length; i++) { + var tuple = serializedVectors[i], + ref = tuple[0], + elements = tuple[1] + + fieldVectors[ref] = new lunr.Vector(elements) + } + + for (var i = 0; i < serializedInvertedIndex.length; i++) { + var tuple = serializedInvertedIndex[i], + term = tuple[0], + posting = tuple[1] + + tokenSetBuilder.insert(term) + invertedIndex[term] = posting + } + + tokenSetBuilder.finish() + + attrs.fields = serializedIndex.fields + + attrs.fieldVectors = fieldVectors + attrs.invertedIndex = invertedIndex + attrs.tokenSet = tokenSetBuilder.root + attrs.pipeline = pipeline + + return new lunr.Index(attrs) + } + /*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ + + /** + * lunr.Builder performs indexing on a set of documents and + * returns instances of lunr.Index ready for querying. + * + * All configuration of the index is done via the builder, the + * fields to index, the document reference, the text processing + * pipeline and document scoring parameters are all set on the + * builder before indexing. + * + * @constructor + * @property {string} _ref - Internal reference to the document reference field. + * @property {string[]} _fields - Internal reference to the document fields to index. + * @property {object} invertedIndex - The inverted index maps terms to document fields. + * @property {object} documentTermFrequencies - Keeps track of document term frequencies. + * @property {object} documentLengths - Keeps track of the length of documents added to the index. + * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing. + * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing. + * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index. + * @property {number} documentCount - Keeps track of the total number of documents indexed. + * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75. + * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2. + * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space. + * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index. + */ + lunr.Builder = function () { + this._ref = "id" + this._fields = Object.create(null) + this._documents = Object.create(null) + this.invertedIndex = Object.create(null) + this.fieldTermFrequencies = {} + this.fieldLengths = {} + this.tokenizer = lunr.tokenizer + this.pipeline = new lunr.Pipeline + this.searchPipeline = new lunr.Pipeline + this.documentCount = 0 + this._b = 0.75 + this._k1 = 1.2 + this.termIndex = 0 + this.metadataWhitelist = [] + } + + /** + * Sets the document field used as the document reference. Every document must have this field. + * The type of this field in the document should be a string, if it is not a string it will be + * coerced into a string by calling toString. + * + * The default ref is 'id'. + * + * The ref should _not_ be changed during indexing, it should be set before any documents are + * added to the index. Changing it during indexing can lead to inconsistent results. + * + * @param {string} ref - The name of the reference field in the document. + */ + lunr.Builder.prototype.ref = function (ref) { + this._ref = ref + } + + /** + * A function that is used to extract a field from a document. + * + * Lunr expects a field to be at the top level of a document, if however the field + * is deeply nested within a document an extractor function can be used to extract + * the right field for indexing. + * + * @callback fieldExtractor + * @param {object} doc - The document being added to the index. + * @returns {?(string|object|object[])} obj - The object that will be indexed for this field. + * @example Extracting a nested field + * function (doc) { return doc.nested.field } + */ + + /** + * Adds a field to the list of document fields that will be indexed. Every document being + * indexed should have this field. Null values for this field in indexed documents will + * not cause errors but will limit the chance of that document being retrieved by searches. + * + * All fields should be added before adding documents to the index. Adding fields after + * a document has been indexed will have no effect on already indexed documents. + * + * Fields can be boosted at build time. This allows terms within that field to have more + * importance when ranking search results. Use a field boost to specify that matches within + * one field are more important than other fields. + * + * @param {string} fieldName - The name of a field to index in all documents. + * @param {object} attributes - Optional attributes associated with this field. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this field. + * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document. + * @throws {RangeError} fieldName cannot contain unsupported characters '/' + */ + lunr.Builder.prototype.field = function (fieldName, attributes) { + if (/\//.test(fieldName)) { + throw new RangeError("Field '" + fieldName + "' contains illegal character '/'") + } + + this._fields[fieldName] = attributes || {} + } + + /** + * A parameter to tune the amount of field length normalisation that is applied when + * calculating relevance scores. A value of 0 will completely disable any normalisation + * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b + * will be clamped to the range 0 - 1. + * + * @param {number} number - The value to set for this tuning parameter. + */ + lunr.Builder.prototype.b = function (number) { + if (number < 0) { + this._b = 0 + } else if (number > 1) { + this._b = 1 + } else { + this._b = number + } + } + + /** + * A parameter that controls the speed at which a rise in term frequency results in term + * frequency saturation. The default value is 1.2. Setting this to a higher value will give + * slower saturation levels, a lower value will result in quicker saturation. + * + * @param {number} number - The value to set for this tuning parameter. + */ + lunr.Builder.prototype.k1 = function (number) { + this._k1 = number + } + + /** + * Adds a document to the index. + * + * Before adding fields to the index the index should have been fully setup, with the document + * ref and all fields to index already having been specified. + * + * The document must have a field name as specified by the ref (by default this is 'id') and + * it should have all fields defined for indexing, though null or undefined values will not + * cause errors. + * + * Entire documents can be boosted at build time. Applying a boost to a document indicates that + * this document should rank higher in search results than other documents. + * + * @param {object} doc - The document to add to the index. + * @param {object} attributes - Optional attributes associated with this document. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this document. + */ + lunr.Builder.prototype.add = function (doc, attributes) { + var docRef = doc[this._ref], + fields = Object.keys(this._fields) + + this._documents[docRef] = attributes || {} + this.documentCount += 1 + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i], + extractor = this._fields[fieldName].extractor, + field = extractor ? extractor(doc) : doc[fieldName], + tokens = this.tokenizer(field, { + fields: [fieldName] + }), + terms = this.pipeline.run(tokens), + fieldRef = new lunr.FieldRef(docRef, fieldName), + fieldTerms = Object.create(null) + + this.fieldTermFrequencies[fieldRef] = fieldTerms + this.fieldLengths[fieldRef] = 0 + + // store the length of this field for this document + this.fieldLengths[fieldRef] += terms.length + + // calculate term frequencies for this field + for (var j = 0; j < terms.length; j++) { + var term = terms[j] + + if (fieldTerms[term] == undefined) { + fieldTerms[term] = 0 + } + + fieldTerms[term] += 1 + + // add to inverted index + // create an initial posting if one doesn't exist + if (this.invertedIndex[term] == undefined) { + var posting = Object.create(null) + posting["_index"] = this.termIndex + this.termIndex += 1 + + for (var k = 0; k < fields.length; k++) { + posting[fields[k]] = Object.create(null) + } + + this.invertedIndex[term] = posting + } + + // add an entry for this term/fieldName/docRef to the invertedIndex + if (this.invertedIndex[term][fieldName][docRef] == undefined) { + this.invertedIndex[term][fieldName][docRef] = Object.create(null) + } + + // store all whitelisted metadata about this token in the + // inverted index + for (var l = 0; l < this.metadataWhitelist.length; l++) { + var metadataKey = this.metadataWhitelist[l], + metadata = term.metadata[metadataKey] + + if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) { + this.invertedIndex[term][fieldName][docRef][metadataKey] = [] + } + + this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata) + } + } + + } + } + + /** + * Calculates the average document length for this index + * + * @private + */ + lunr.Builder.prototype.calculateAverageFieldLengths = function () { + + var fieldRefs = Object.keys(this.fieldLengths), + numberOfFields = fieldRefs.length, + accumulator = {}, + documentsWithField = {} + + for (var i = 0; i < numberOfFields; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + field = fieldRef.fieldName + + documentsWithField[field] || (documentsWithField[field] = 0) + documentsWithField[field] += 1 + + accumulator[field] || (accumulator[field] = 0) + accumulator[field] += this.fieldLengths[fieldRef] + } + + var fields = Object.keys(this._fields) + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i] + accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName] + } + + this.averageFieldLength = accumulator + } + + /** + * Builds a vector space model of every document using lunr.Vector + * + * @private + */ + lunr.Builder.prototype.createFieldVectors = function () { + var fieldVectors = {}, + fieldRefs = Object.keys(this.fieldTermFrequencies), + fieldRefsLength = fieldRefs.length, + termIdfCache = Object.create(null) + + for (var i = 0; i < fieldRefsLength; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + fieldName = fieldRef.fieldName, + fieldLength = this.fieldLengths[fieldRef], + fieldVector = new lunr.Vector, + termFrequencies = this.fieldTermFrequencies[fieldRef], + terms = Object.keys(termFrequencies), + termsLength = terms.length + + + var fieldBoost = this._fields[fieldName].boost || 1, + docBoost = this._documents[fieldRef.docRef].boost || 1 + + for (var j = 0; j < termsLength; j++) { + var term = terms[j], + tf = termFrequencies[term], + termIndex = this.invertedIndex[term]._index, + idf, score, scoreWithPrecision + + if (termIdfCache[term] === undefined) { + idf = lunr.idf(this.invertedIndex[term], this.documentCount) + termIdfCache[term] = idf + } else { + idf = termIdfCache[term] + } + + score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf) + score *= fieldBoost + score *= docBoost + scoreWithPrecision = Math.round(score * 1000) / 1000 + // Converts 1.23456789 to 1.234. + // Reducing the precision so that the vectors take up less + // space when serialised. Doing it now so that they behave + // the same before and after serialisation. Also, this is + // the fastest approach to reducing a number's precision in + // JavaScript. + + fieldVector.insert(termIndex, scoreWithPrecision) + } + + fieldVectors[fieldRef] = fieldVector + } + + this.fieldVectors = fieldVectors + } + + /** + * Creates a token set of all tokens in the index using lunr.TokenSet + * + * @private + */ + lunr.Builder.prototype.createTokenSet = function () { + this.tokenSet = lunr.TokenSet.fromArray( + Object.keys(this.invertedIndex).sort() + ) + } + + /** + * Builds the index, creating an instance of lunr.Index. + * + * This completes the indexing process and should only be called + * once all documents have been added to the index. + * + * @returns {lunr.Index} + */ + lunr.Builder.prototype.build = function () { + this.calculateAverageFieldLengths() + this.createFieldVectors() + this.createTokenSet() + + return new lunr.Index({ + invertedIndex: this.invertedIndex, + fieldVectors: this.fieldVectors, + tokenSet: this.tokenSet, + fields: Object.keys(this._fields), + pipeline: this.searchPipeline + }) + } + + /** + * Applies a plugin to the index builder. + * + * A plugin is a function that is called with the index builder as its context. + * Plugins can be used to customise or extend the behaviour of the index + * in some way. A plugin is just a function, that encapsulated the custom + * behaviour that should be applied when building the index. + * + * The plugin function will be called with the index builder as its argument, additional + * arguments can also be passed when calling use. The function will be called + * with the index builder as its context. + * + * @param {Function} plugin The plugin to apply. + */ + lunr.Builder.prototype.use = function (fn) { + var args = Array.prototype.slice.call(arguments, 1) + args.unshift(this) + fn.apply(this, args) + } + /** + * Contains and collects metadata about a matching document. + * A single instance of lunr.MatchData is returned as part of every + * lunr.Index~Result. + * + * @constructor + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + * @property {object} metadata - A cloned collection of metadata associated with this document. + * @see {@link lunr.Index~Result} + */ + lunr.MatchData = function (term, field, metadata) { + var clonedMetadata = Object.create(null), + metadataKeys = Object.keys(metadata || {}) + + // Cloning the metadata to prevent the original + // being mutated during match data combination. + // Metadata is kept in an array within the inverted + // index so cloning the data can be done with + // Array#slice + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i] + clonedMetadata[key] = metadata[key].slice() + } + + this.metadata = Object.create(null) + + if (term !== undefined) { + this.metadata[term] = Object.create(null) + this.metadata[term][field] = clonedMetadata + } + } + + /** + * An instance of lunr.MatchData will be created for every term that matches a + * document. However only one instance is required in a lunr.Index~Result. This + * method combines metadata from another instance of lunr.MatchData with this + * objects metadata. + * + * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one. + * @see {@link lunr.Index~Result} + */ + lunr.MatchData.prototype.combine = function (otherMatchData) { + var terms = Object.keys(otherMatchData.metadata) + + for (var i = 0; i < terms.length; i++) { + var term = terms[i], + fields = Object.keys(otherMatchData.metadata[term]) + + if (this.metadata[term] == undefined) { + this.metadata[term] = Object.create(null) + } + + for (var j = 0; j < fields.length; j++) { + var field = fields[j], + keys = Object.keys(otherMatchData.metadata[term][field]) + + if (this.metadata[term][field] == undefined) { + this.metadata[term][field] = Object.create(null) + } + + for (var k = 0; k < keys.length; k++) { + var key = keys[k] + + if (this.metadata[term][field][key] == undefined) { + this.metadata[term][field][key] = otherMatchData.metadata[term][field][key] + } else { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key]) + } + + } + } + } + } + + /** + * Add metadata for a term/field pair to this instance of match data. + * + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + */ + lunr.MatchData.prototype.add = function (term, field, metadata) { + if (!(term in this.metadata)) { + this.metadata[term] = Object.create(null) + this.metadata[term][field] = metadata + return + } + + if (!(field in this.metadata[term])) { + this.metadata[term][field] = metadata + return + } + + var metadataKeys = Object.keys(metadata) + + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i] + + if (key in this.metadata[term][field]) { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key]) + } else { + this.metadata[term][field][key] = metadata[key] + } + } + } + /** + * A lunr.Query provides a programmatic way of defining queries to be performed + * against a {@link lunr.Index}. + * + * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method + * so the query object is pre-initialized with the right index fields. + * + * @constructor + * @property {lunr.Query~Clause[]} clauses - An array of query clauses. + * @property {string[]} allFields - An array of all available fields in a lunr.Index. + */ + lunr.Query = function (allFields) { + this.clauses = [] + this.allFields = allFields + } + + /** + * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause. + * + * This allows wildcards to be added to the beginning and end of a term without having to manually do any string + * concatenation. + * + * The wildcard constants can be bitwise combined to select both leading and trailing wildcards. + * + * @constant + * @default + * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour + * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists + * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with trailing wildcard + * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING }) + * @example query term with leading and trailing wildcard + * query.term('foo', { + * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING + * }) + */ + + lunr.Query.wildcard = new String("*") + lunr.Query.wildcard.NONE = 0 + lunr.Query.wildcard.LEADING = 1 + lunr.Query.wildcard.TRAILING = 2 + + /** + * Constants for indicating what kind of presence a term must have in matching documents. + * + * @constant + * @enum {number} + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with required presence + * query.term('foo', { presence: lunr.Query.presence.REQUIRED }) + */ + lunr.Query.presence = { + /** + * Term's presence in a document is optional, this is the default value. + */ + OPTIONAL: 1, + + /** + * Term's presence in a document is required, documents that do not contain + * this term will not be returned. + */ + REQUIRED: 2, + + /** + * Term's presence in a document is prohibited, documents that do contain + * this term will not be returned. + */ + PROHIBITED: 3 + } + + /** + * A single clause in a {@link lunr.Query} contains a term and details on how to + * match that term against a {@link lunr.Index}. + * + * @typedef {Object} lunr.Query~Clause + * @property {string[]} fields - The fields in an index this clause should be matched against. + * @property {number} [boost=1] - Any boost that should be applied when matching this clause. + * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be. + * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline. + * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended. + * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents. + */ + + /** + * Adds a {@link lunr.Query~Clause} to this query. + * + * Unless the clause contains the fields to be matched all fields will be matched. In addition + * a default boost of 1 is applied to the clause. + * + * @param {lunr.Query~Clause} clause - The clause to add to this query. + * @see lunr.Query~Clause + * @returns {lunr.Query} + */ + lunr.Query.prototype.clause = function (clause) { + if (!('fields' in clause)) { + clause.fields = this.allFields + } + + if (!('boost' in clause)) { + clause.boost = 1 + } + + if (!('usePipeline' in clause)) { + clause.usePipeline = true + } + + if (!('wildcard' in clause)) { + clause.wildcard = lunr.Query.wildcard.NONE + } + + if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) { + clause.term = "*" + clause.term + } + + if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) { + clause.term = "" + clause.term + "*" + } + + if (!('presence' in clause)) { + clause.presence = lunr.Query.presence.OPTIONAL + } + + this.clauses.push(clause) + + return this + } + + /** + * A negated query is one in which every clause has a presence of + * prohibited. These queries require some special processing to return + * the expected results. + * + * @returns boolean + */ + lunr.Query.prototype.isNegated = function () { + for (var i = 0; i < this.clauses.length; i++) { + if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) { + return false + } + } + + return true + } + + /** + * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause} + * to the list of clauses that make up this query. + * + * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion + * to a token or token-like string should be done before calling this method. + * + * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an + * array, each term in the array will share the same options. + * + * @param {object|object[]} term - The term(s) to add to the query. + * @param {object} [options] - Any additional properties to add to the query clause. + * @returns {lunr.Query} + * @see lunr.Query#clause + * @see lunr.Query~Clause + * @example adding a single term to a query + * query.term("foo") + * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard + * query.term("foo", { + * fields: ["title"], + * boost: 10, + * wildcard: lunr.Query.wildcard.TRAILING + * }) + * @example using lunr.tokenizer to convert a string to tokens before using them as terms + * query.term(lunr.tokenizer("foo bar")) + */ + lunr.Query.prototype.term = function (term, options) { + if (Array.isArray(term)) { + term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this) + return this + } + + var clause = options || {} + clause.term = term.toString() + + this.clause(clause) + + return this + } + lunr.QueryParseError = function (message, start, end) { + this.name = "QueryParseError" + this.message = message + this.start = start + this.end = end + } + + lunr.QueryParseError.prototype = new Error + lunr.QueryLexer = function (str) { + this.lexemes = [] + this.str = str + this.length = str.length + this.pos = 0 + this.start = 0 + this.escapeCharPositions = [] + } + + lunr.QueryLexer.prototype.run = function () { + var state = lunr.QueryLexer.lexText + + while (state) { + state = state(this) + } + } + + lunr.QueryLexer.prototype.sliceString = function () { + var subSlices = [], + sliceStart = this.start, + sliceEnd = this.pos + + for (var i = 0; i < this.escapeCharPositions.length; i++) { + sliceEnd = this.escapeCharPositions[i] + subSlices.push(this.str.slice(sliceStart, sliceEnd)) + sliceStart = sliceEnd + 1 + } + + subSlices.push(this.str.slice(sliceStart, this.pos)) + this.escapeCharPositions.length = 0 + + return subSlices.join('') + } + + lunr.QueryLexer.prototype.emit = function (type) { + this.lexemes.push({ + type: type, + str: this.sliceString(), + start: this.start, + end: this.pos + }) + + this.start = this.pos + } + + lunr.QueryLexer.prototype.escapeCharacter = function () { + this.escapeCharPositions.push(this.pos - 1) + this.pos += 1 + } + + lunr.QueryLexer.prototype.next = function () { + if (this.pos >= this.length) { + return lunr.QueryLexer.EOS + } + + var char = this.str.charAt(this.pos) + this.pos += 1 + return char + } + + lunr.QueryLexer.prototype.width = function () { + return this.pos - this.start + } + + lunr.QueryLexer.prototype.ignore = function () { + if (this.start == this.pos) { + this.pos += 1 + } + + this.start = this.pos + } + + lunr.QueryLexer.prototype.backup = function () { + this.pos -= 1 + } + + lunr.QueryLexer.prototype.acceptDigitRun = function () { + var char, charCode + + do { + char = this.next() + charCode = char.charCodeAt(0) + } while (charCode > 47 && charCode < 58) + + if (char != lunr.QueryLexer.EOS) { + this.backup() + } + } + + lunr.QueryLexer.prototype.more = function () { + return this.pos < this.length + } + + lunr.QueryLexer.EOS = 'EOS' + lunr.QueryLexer.FIELD = 'FIELD' + lunr.QueryLexer.TERM = 'TERM' + lunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE' + lunr.QueryLexer.BOOST = 'BOOST' + lunr.QueryLexer.PRESENCE = 'PRESENCE' + + lunr.QueryLexer.lexField = function (lexer) { + lexer.backup() + lexer.emit(lunr.QueryLexer.FIELD) + lexer.ignore() + return lunr.QueryLexer.lexText + } + + lunr.QueryLexer.lexTerm = function (lexer) { + if (lexer.width() > 1) { + lexer.backup() + lexer.emit(lunr.QueryLexer.TERM) + } + + lexer.ignore() + + if (lexer.more()) { + return lunr.QueryLexer.lexText + } + } + + lunr.QueryLexer.lexEditDistance = function (lexer) { + lexer.ignore() + lexer.acceptDigitRun() + lexer.emit(lunr.QueryLexer.EDIT_DISTANCE) + return lunr.QueryLexer.lexText + } + + lunr.QueryLexer.lexBoost = function (lexer) { + lexer.ignore() + lexer.acceptDigitRun() + lexer.emit(lunr.QueryLexer.BOOST) + return lunr.QueryLexer.lexText + } + + lunr.QueryLexer.lexEOS = function (lexer) { + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } + } + + // This matches the separator used when tokenising fields + // within a document. These should match otherwise it is + // not possible to search for some tokens within a document. + // + // It is possible for the user to change the separator on the + // tokenizer so it _might_ clash with any other of the special + // characters already used within the search string, e.g. :. + // + // This means that it is possible to change the separator in + // such a way that makes some words unsearchable using a search + // string. + lunr.QueryLexer.termSeparator = lunr.tokenizer.separator + + lunr.QueryLexer.lexText = function (lexer) { + while (true) { + var char = lexer.next() + + if (char == lunr.QueryLexer.EOS) { + return lunr.QueryLexer.lexEOS + } + + // Escape character is '\' + if (char.charCodeAt(0) == 92) { + lexer.escapeCharacter() + continue + } + + if (char == ":") { + return lunr.QueryLexer.lexField + } + + if (char == "~") { + lexer.backup() + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } + return lunr.QueryLexer.lexEditDistance + } + + if (char == "^") { + lexer.backup() + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } + return lunr.QueryLexer.lexBoost + } + + // "+" indicates term presence is required + // checking for length to ensure that only + // leading "+" are considered + if (char == "+" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE) + return lunr.QueryLexer.lexText + } + + // "-" indicates term presence is prohibited + // checking for length to ensure that only + // leading "-" are considered + if (char == "-" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE) + return lunr.QueryLexer.lexText + } + + if (char.match(lunr.QueryLexer.termSeparator)) { + return lunr.QueryLexer.lexTerm + } + } + } + + lunr.QueryParser = function (str, query) { + this.lexer = new lunr.QueryLexer(str) + this.query = query + this.currentClause = {} + this.lexemeIdx = 0 + } + + lunr.QueryParser.prototype.parse = function () { + this.lexer.run() + this.lexemes = this.lexer.lexemes + + var state = lunr.QueryParser.parseClause + + while (state) { + state = state(this) + } + + return this.query + } + + lunr.QueryParser.prototype.peekLexeme = function () { + return this.lexemes[this.lexemeIdx] + } + + lunr.QueryParser.prototype.consumeLexeme = function () { + var lexeme = this.peekLexeme() + this.lexemeIdx += 1 + return lexeme + } + + lunr.QueryParser.prototype.nextClause = function () { + var completedClause = this.currentClause + this.query.clause(completedClause) + this.currentClause = {} + } + + lunr.QueryParser.parseClause = function (parser) { + var lexeme = parser.peekLexeme() + + if (lexeme == undefined) { + return + } + + switch (lexeme.type) { + case lunr.QueryLexer.PRESENCE: + return lunr.QueryParser.parsePresence + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expected either a field or a term, found " + lexeme.type + + if (lexeme.str.length >= 1) { + errorMessage += " with value '" + lexeme.str + "'" + } + + throw new lunr.QueryParseError(errorMessage, lexeme.start, lexeme.end) + } + } + + lunr.QueryParser.parsePresence = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + switch (lexeme.str) { + case "-": + parser.currentClause.presence = lunr.Query.presence.PROHIBITED + break + case "+": + parser.currentClause.presence = lunr.Query.presence.REQUIRED + break + default: + var errorMessage = "unrecognised presence operator'" + lexeme.str + "'" + throw new lunr.QueryParseError(errorMessage, lexeme.start, lexeme.end) + } + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + var errorMessage = "expecting term or field, found nothing" + throw new lunr.QueryParseError(errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term or field, found '" + nextLexeme.type + "'" + throw new lunr.QueryParseError(errorMessage, nextLexeme.start, nextLexeme.end) + } + } + + lunr.QueryParser.parseField = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + if (parser.query.allFields.indexOf(lexeme.str) == -1) { + var possibleFields = parser.query.allFields.map(function (f) { return "'" + f + "'" }).join(', '), + errorMessage = "unrecognised field '" + lexeme.str + "', possible fields: " + possibleFields + + throw new lunr.QueryParseError(errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.fields = [lexeme.str] + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + var errorMessage = "expecting term, found nothing" + throw new lunr.QueryParseError(errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term, found '" + nextLexeme.type + "'" + throw new lunr.QueryParseError(errorMessage, nextLexeme.start, nextLexeme.end) + } + } + + lunr.QueryParser.parseTerm = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + parser.currentClause.term = lexeme.str.toLowerCase() + + if (lexeme.str.indexOf("*") != -1) { + parser.currentClause.usePipeline = false + } + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError(errorMessage, nextLexeme.start, nextLexeme.end) + } + } + + lunr.QueryParser.parseEditDistance = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + var editDistance = parseInt(lexeme.str, 10) + + if (isNaN(editDistance)) { + var errorMessage = "edit distance must be numeric" + throw new lunr.QueryParseError(errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.editDistance = editDistance + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError(errorMessage, nextLexeme.start, nextLexeme.end) + } + } + + lunr.QueryParser.parseBoost = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + var boost = parseInt(lexeme.str, 10) + + if (isNaN(boost)) { + var errorMessage = "boost must be numeric" + throw new lunr.QueryParseError(errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.boost = boost + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError(errorMessage, nextLexeme.start, nextLexeme.end) + } + } + + /** + * export the module via AMD, CommonJS or as a browser global + * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js + */ + ; (function (root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(factory) + } else if (typeof exports === 'object') { + /** + * Node. Does not work with strict CommonJS, but + * only CommonJS-like enviroments that support module.exports, + * like Node. + */ + module.exports = factory() + } else { + // Browser globals (root is window) + root.lunr = factory() + } + }(this, function () { + /** + * Just return a value to define the module export. + * This example returns an object, but the module + * can return a function as the exported value. + */ + return lunr + })) +})(); diff --git a/project/build.properties b/project/build.properties deleted file mode 100644 index f2f13471..00000000 --- a/project/build.properties +++ /dev/null @@ -1 +0,0 @@ -sbt.version = 1.9.9 \ No newline at end of file diff --git a/project/plugins.sbt b/project/plugins.sbt deleted file mode 100644 index 42e7f222..00000000 --- a/project/plugins.sbt +++ /dev/null @@ -1,10 +0,0 @@ -addSbtPlugin("org.scoverage" % "sbt-scoverage" % "2.2.2") -addSbtPlugin("com.47deg" % "sbt-microsites" % "1.4.4") -addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.7.0") -addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.6.1") -addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0") -addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.4") - -ThisBuild / libraryDependencySchemes ++= Seq( - "org.scala-lang.modules" %% "scala-xml" % VersionScheme.Always -) diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/common.scala b/prox-core/src/main/scala/io/github/vigoo/prox/common.scala deleted file mode 100644 index 6bcf4d3b..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/common.scala +++ /dev/null @@ -1,79 +0,0 @@ -package io.github.vigoo.prox - -import java.nio.file.Path - -trait CommonModule { - this: Prox => - - trait ProcessLikeConfiguration { - val workingDirectory: Option[Path] - val environmentVariables: Map[String, String] - val removedEnvironmentVariables: Set[String] - - type Self <: ProcessLikeConfiguration - - protected def applyConfiguration( - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): Self - - /** Changes the working directory of the process - * - * @param workingDirectory - * the working directory - * @return - * a new process with the working directory set - */ - def in(workingDirectory: Path): Self = - applyConfiguration( - workingDirectory = Some(workingDirectory), - environmentVariables, - removedEnvironmentVariables - ) - - /** Use the inherited working directory of the process instead of an - * explicit one - * - * @return - * a new process with the working directory cleared - */ - def inInheritedWorkingDirectory(): Self = - applyConfiguration( - workingDirectory = None, - environmentVariables, - removedEnvironmentVariables - ) - - /** Adds an environment variable to the process - * - * @param nameValuePair - * A pair of name and value - * @return - * a new process with the working directory set - */ - def `with`(nameValuePair: (String, String)): Self = - applyConfiguration( - workingDirectory, - environmentVariables = environmentVariables + nameValuePair, - removedEnvironmentVariables - ) - - /** Removes an environment variable from the process - * - * Usable to remove variables inherited from the parent process. - * - * @param name - * Name of the environment variable - * @return - * a new process with the working directory set - */ - def without(name: String): Self = - applyConfiguration( - workingDirectory, - environmentVariables, - removedEnvironmentVariables = removedEnvironmentVariables + name - ) - - } -} diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/errors.scala b/prox-core/src/main/scala/io/github/vigoo/prox/errors.scala deleted file mode 100644 index 1420c84d..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/errors.scala +++ /dev/null @@ -1,59 +0,0 @@ -package io.github.vigoo.prox - -sealed trait ProxError { - def toThrowable: Throwable -} - -final case class FailedToReadProcessOutputException(reason: Throwable) - extends Exception(s"Failed to read process output", reason) -final case class FailedToReadProcessOutput(reason: Throwable) - extends ProxError { - override def toThrowable: Throwable = FailedToReadProcessOutputException( - reason - ) -} - -final case class FailedToWriteProcessInputException(reason: Throwable) - extends Exception(s"Failed to write process input", reason) -final case class FailedToWriteProcessInput(reason: Throwable) - extends ProxError { - override def toThrowable: Throwable = FailedToWriteProcessInputException( - reason - ) -} - -final case class UnknownProxErrorException(reason: Throwable) - extends Exception(s"Unknown prox failure", reason) -final case class UnknownProxError(reason: Throwable) extends ProxError { - override def toThrowable: Throwable = UnknownProxErrorException(reason) -} - -final case class MultipleProxErrorsException(value: List[ProxError]) - extends Exception(s"Multiple prox failures: ${value.mkString(", ")}") -final case class MultipleProxErrors(errors: List[ProxError]) extends ProxError { - override def toThrowable: Throwable = MultipleProxErrorsException(errors) -} - -final case class FailedToQueryStateException(reason: Throwable) - extends Exception(s"Failed to query state of process", reason) -final case class FailedToQueryState(reason: Throwable) extends ProxError { - override def toThrowable: Throwable = FailedToQueryStateException(reason) -} - -final case class FailedToDestroyException(reason: Throwable) - extends Exception(s"Failed to destroy process", reason) -final case class FailedToDestroy(reason: Throwable) extends ProxError { - override def toThrowable: Throwable = FailedToDestroyException(reason) -} - -final case class FailedToWaitForExitException(reason: Throwable) - extends Exception(s"Failed to wait for process to exit", reason) -final case class FailedToWaitForExit(reason: Throwable) extends ProxError { - override def toThrowable: Throwable = FailedToWaitForExitException(reason) -} - -final case class FailedToStartProcessException(reason: Throwable) - extends Exception(s"Failed to start process", reason) -final case class FailedToStartProcess(reason: Throwable) extends ProxError { - override def toThrowable: Throwable = FailedToStartProcessException(reason) -} diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/package.scala b/prox-core/src/main/scala/io/github/vigoo/prox/package.scala deleted file mode 100644 index 6300ee41..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/package.scala +++ /dev/null @@ -1,37 +0,0 @@ -package io.github.vigoo - -/** 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]]. - * - * @author - * Daniel Vigovszky - */ -package object prox { - trait Prox - extends ProxRuntime - with CommonModule - with ProcessModule - with ProcessGroupModule - with RedirectionModule - with ProcessRunnerModule - with SyntaxModule - - /** Common base trait for processes and process groups, used in constraints in - * the redirection traits - */ - trait ProcessLike -} diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/path/package.scala b/prox-core/src/main/scala/io/github/vigoo/prox/path/package.scala deleted file mode 100644 index c0ba03cf..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/path/package.scala +++ /dev/null @@ -1,27 +0,0 @@ -package io.github.vigoo.prox - -import java.nio.file.{Path, Paths} - -/** Small helper package to work with Java NIO paths */ -package object path { - - /** The home directory */ - val home: Path = Paths.get(java.lang.System.getProperty("user.home")) - - /** The root directory */ - val root: Path = Paths.get("/") - - /** Extension methods for [[java.nio.file.Path]] */ - implicit class PathOps(value: Path) { - - /** Resolves a child of the given path - * - * @param child - * The child's name - * @return - * Returns the path to the given child - */ - def /(child: String): Path = value.resolve(child) - } - -} diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/process.scala b/prox-core/src/main/scala/io/github/vigoo/prox/process.scala deleted file mode 100644 index 5bac6ad8..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/process.scala +++ /dev/null @@ -1,752 +0,0 @@ -package io.github.vigoo.prox - -import java.nio.file.Path - -trait ProcessModule { - this: Prox => - - /** Result of a finished process - * - * @tparam O - * Output type - * @tparam E - * Error output type - */ - trait ProcessResult[+O, +E] { - - /** The exit code of the process */ - val exitCode: ProxExitCode - - /** Output value of the process, depends on what output redirection was - * applied - */ - val output: O - - /** Error output value of the process, depends on what error redirection was - * applied - */ - val error: E - } - - /** Default implementation of [[ProcessResult]] */ - case class SimpleProcessResult[+O, +E]( - override val exitCode: ProxExitCode, - override val output: O, - override val error: E - ) extends ProcessResult[O, E] - - /** Representation of a running process - * - * @tparam O - * Output type - * @tparam E - * Error output type - * @tparam Info - * Runner-specific process information - */ - trait RunningProcess[O, E, +Info] { - val runningInput: ProxFiber[Unit] - val runningOutput: ProxFiber[O] - val runningError: ProxFiber[E] - - /** Gets the runner-specific process information */ - val info: Info - - /** Checks whether the process is still running */ - def isAlive: ProxIO[Boolean] - - /** Forced termination of the process. Blocks until the process stops. */ - def kill(): ProxIO[ProcessResult[O, E]] - - /** Normal termination of the process. Blocks until the process stops. */ - def terminate(): ProxIO[ProcessResult[O, E]] - - /** Block until the process stops */ - def waitForExit(): ProxIO[ProcessResult[O, E]] - - def mapInfo[I2](f: Info => I2): RunningProcess[O, E, I2] = - new RunningProcess[O, E, I2] { - override val runningInput: ProxFiber[Unit] = - RunningProcess.this.runningInput - override val runningOutput: ProxFiber[O] = - RunningProcess.this.runningOutput - override val runningError: ProxFiber[E] = - RunningProcess.this.runningError - override val info: I2 = f(RunningProcess.this.info) - - override def isAlive: ProxIO[Boolean] = RunningProcess.this.isAlive - - override def kill(): ProxIO[ProcessResult[O, E]] = - RunningProcess.this.kill() - - override def terminate(): ProxIO[ProcessResult[O, E]] = - RunningProcess.this.terminate() - - override def waitForExit(): ProxIO[ProcessResult[O, E]] = - RunningProcess.this.waitForExit() - } - } - - /** 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. - * - * @tparam O - * Output type - * @tparam E - * Error output type - */ - trait Process[O, E] extends ProcessLike with ProcessConfiguration { - override type Self <: Process[O, E] - - val command: String - val arguments: List[String] - val workingDirectory: Option[Path] - val environmentVariables: Map[String, String] - val removedEnvironmentVariables: Set[String] - - val outputRedirection: OutputRedirection - val runOutputStream: java.io.InputStream => ProxIO[O] - val errorRedirection: OutputRedirection - val runErrorStream: java.io.InputStream => ProxIO[E] - val inputRedirection: InputRedirection - - /** 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. - * - * @param runner - * The process runner to be used - * @tparam Info - * The runner-specific process info type - * @return - * interface for handling the running process - */ - def startProcess[Info]()(implicit - runner: ProcessRunner[Info] - ): ProxIO[RunningProcess[O, E, Info]] = - runner.startProcess(this) - - /** 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). - * - * @param runner - * The process runner to be used - * @return - * a managed fiber representing the running process - */ - def start[Info]()(implicit - runner: ProcessRunner[Info] - ): ProxResource[ProxFiber[ProcessResult[O, E]]] = - runner.start(this) - - /** Starts the process asynchronously and blocks the execution until it is - * finished - * - * @param runner - * The process runner to be used - * @return - * the result of the finished process - */ - def run[Info]()(implicit - runner: ProcessRunner[Info] - ): ProxIO[ProcessResult[O, E]] = - start().use(_.join) - } - - /** The capability to configure process execution details - */ - trait ProcessConfiguration extends ProcessLikeConfiguration { - this: Process[_, _] => - -// override type Self <: ProcessConfiguration - - override protected def applyConfiguration( - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): Self = - selfCopy( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - - protected def selfCopy( - command: String, - arguments: List[String], - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): Self - - /** Replaces the command - * - * @param newCommand - * new value for the command to be executed - * @return - * returns a new process specification - */ - def withCommand(newCommand: String): Self = - selfCopy( - newCommand, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - - /** Replaces the arguments - * - * @param newArguments - * new list of arguments - * @return - * returns a new process specification - */ - def withArguments(newArguments: List[String]): Self = - selfCopy( - command, - newArguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - } - - object Process { - - /** Process with unbound input stream */ - type UnboundIProcess[O, E] = Process[O, E] - with RedirectableInput[Process[O, E]] - - /** Process with unbound output stream */ - type UnboundOProcess[E] = Process[Unit, E] - with RedirectableOutput[Process[*, E]] - - /** Process with unbound error stream */ - type UnboundEProcess[O] = Process[O, Unit] - with RedirectableError[Process[O, *]] - - /** Process with unbound input and output streams */ - type UnboundIOProcess[E] = Process[Unit, E] - with RedirectableInput[UnboundOProcess[E]] - with RedirectableOutput[UnboundIProcess[*, E]] - - /** Process with unbound input and error streams */ - type UnboundIEProcess[O] = Process[O, Unit] - with RedirectableInput[UnboundEProcess[O]] - with RedirectableError[UnboundIProcess[O, *]] - - /** Process with unbound output and error streams */ - type UnboundOEProcess = Process[Unit, Unit] - with RedirectableOutput[UnboundEProcess[*]] - with RedirectableError[UnboundOProcess[*]] - - /** Process with unbound input, output and error streams */ - type UnboundProcess = Process[Unit, Unit] - with RedirectableInput[UnboundOEProcess] - with RedirectableOutput[UnboundIEProcess[*]] - with RedirectableError[UnboundIOProcess[*]] - - /** Process with bound input, output and error streams */ - case class ProcessImplIOE[O, E]( - override val command: String, - override val arguments: List[String], - override val workingDirectory: Option[Path], - override val environmentVariables: Map[String, String], - override val removedEnvironmentVariables: Set[String], - override val outputRedirection: OutputRedirection, - override val runOutputStream: java.io.InputStream => ProxIO[O], - override val errorRedirection: OutputRedirection, - override val runErrorStream: java.io.InputStream => ProxIO[E], - override val inputRedirection: InputRedirection - ) extends Process[O, E] { - - override type Self = ProcessImplIOE[O, E] - - override protected def selfCopy( - command: String, - arguments: List[String], - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): ProcessImplIOE[O, E] = - copy( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - } - - /** Process with bound input and output streams */ - case class ProcessImplIO[O]( - override val command: String, - override val arguments: List[String], - override val workingDirectory: Option[Path], - override val environmentVariables: Map[String, String], - override val removedEnvironmentVariables: Set[String], - override val outputRedirection: OutputRedirection, - override val runOutputStream: java.io.InputStream => ProxIO[O], - override val errorRedirection: OutputRedirection, - override val runErrorStream: java.io.InputStream => ProxIO[Unit], - override val inputRedirection: InputRedirection - ) extends Process[O, Unit] - with RedirectableError[ProcessImplIOE[O, *]] { - - override type Self = ProcessImplIO[O] - - override def connectError[R <: OutputRedirection, RE](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RE] - ): ProcessImplIOE[O, RE] = - ProcessImplIOE( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - outputRedirection, - runOutputStream, - target, - outputRedirectionType.runner(target), - inputRedirection - ) - - override protected def selfCopy( - command: String, - arguments: List[String], - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): ProcessImplIO[O] = - copy( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - } - - /** Process with bound input and error streams */ - case class ProcessImplIE[E]( - override val command: String, - override val arguments: List[String], - override val workingDirectory: Option[Path], - override val environmentVariables: Map[String, String], - override val removedEnvironmentVariables: Set[String], - override val outputRedirection: OutputRedirection, - override val runOutputStream: java.io.InputStream => ProxIO[Unit], - override val errorRedirection: OutputRedirection, - override val runErrorStream: java.io.InputStream => ProxIO[E], - override val inputRedirection: InputRedirection - ) extends Process[Unit, E] - with RedirectableOutput[ProcessImplIOE[*, E]] { - - override type Self = ProcessImplIE[E] - - override def connectOutput[R <: OutputRedirection, RO](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RO] - ): ProcessImplIOE[RO, E] = - ProcessImplIOE( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - target, - outputRedirectionType.runner(target), - errorRedirection, - runErrorStream, - inputRedirection - ) - - override protected def selfCopy( - command: String, - arguments: List[String], - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): ProcessImplIE[E] = - copy( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - } - - /** Process with bound output and error streams */ - case class ProcessImplOE[O, E]( - override val command: String, - override val arguments: List[String], - override val workingDirectory: Option[Path], - override val environmentVariables: Map[String, String], - override val removedEnvironmentVariables: Set[String], - override val outputRedirection: OutputRedirection, - override val runOutputStream: java.io.InputStream => ProxIO[O], - override val errorRedirection: OutputRedirection, - override val runErrorStream: java.io.InputStream => ProxIO[E], - override val inputRedirection: InputRedirection - ) extends Process[O, E] - with RedirectableInput[ProcessImplIOE[O, E]] { - - override type Self = ProcessImplOE[O, E] - - override def connectInput( - source: InputRedirection - ): ProcessImplIOE[O, E] = - ProcessImplIOE( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - outputRedirection, - runOutputStream, - errorRedirection, - runErrorStream, - source - ) - - override protected def selfCopy( - command: String, - arguments: List[String], - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): ProcessImplOE[O, E] = - copy( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - } - - /** Process with bound output streams */ - case class ProcessImplO[O]( - override val command: String, - override val arguments: List[String], - override val workingDirectory: Option[Path], - override val environmentVariables: Map[String, String], - override val removedEnvironmentVariables: Set[String], - override val outputRedirection: OutputRedirection, - override val runOutputStream: java.io.InputStream => ProxIO[O], - override val errorRedirection: OutputRedirection, - override val runErrorStream: java.io.InputStream => ProxIO[Unit], - override val inputRedirection: InputRedirection - ) extends Process[O, Unit] - with RedirectableError[ProcessImplOE[O, *]] - with RedirectableInput[ProcessImplIO[O]] { - - override type Self = ProcessImplO[O] - - override def connectInput(source: InputRedirection): ProcessImplIO[O] = - ProcessImplIO( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - outputRedirection, - runOutputStream, - errorRedirection, - runErrorStream, - source - ) - - override def connectError[R <: OutputRedirection, RE](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RE] - ): ProcessImplOE[O, RE] = - ProcessImplOE( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - outputRedirection, - runOutputStream, - target, - outputRedirectionType.runner(target), - inputRedirection - ) - - override protected def selfCopy( - command: String, - arguments: List[String], - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): ProcessImplO[O] = - copy( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - } - - /** Process with bound error streams */ - case class ProcessImplE[E]( - override val command: String, - override val arguments: List[String], - override val workingDirectory: Option[Path], - override val environmentVariables: Map[String, String], - override val removedEnvironmentVariables: Set[String], - override val outputRedirection: OutputRedirection, - override val runOutputStream: java.io.InputStream => ProxIO[Unit], - override val errorRedirection: OutputRedirection, - override val runErrorStream: java.io.InputStream => ProxIO[E], - override val inputRedirection: InputRedirection - ) extends Process[Unit, E] - with RedirectableInput[ProcessImplIE[E]] - with RedirectableOutput[ProcessImplOE[*, E]] { - - override type Self = ProcessImplE[E] - - override def connectInput(source: InputRedirection): ProcessImplIE[E] = - ProcessImplIE( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - outputRedirection, - runOutputStream, - errorRedirection, - runErrorStream, - source - ) - - override def connectOutput[R <: OutputRedirection, RO](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RO] - ): ProcessImplOE[RO, E] = - ProcessImplOE( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - target, - outputRedirectionType.runner(target), - errorRedirection, - runErrorStream, - inputRedirection - ) - - override protected def selfCopy( - command: String, - arguments: List[String], - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): ProcessImplE[E] = - copy( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - } - - /** Process with bound input streams */ - case class ProcessImplI( - override val command: String, - override val arguments: List[String], - override val workingDirectory: Option[Path], - override val environmentVariables: Map[String, String], - override val removedEnvironmentVariables: Set[String], - override val outputRedirection: OutputRedirection, - override val runOutputStream: java.io.InputStream => ProxIO[Unit], - override val errorRedirection: OutputRedirection, - override val runErrorStream: java.io.InputStream => ProxIO[Unit], - override val inputRedirection: InputRedirection - ) extends Process[Unit, Unit] - with RedirectableOutput[ProcessImplIO[*]] - with RedirectableError[ProcessImplIE[*]] { - - override type Self = ProcessImplI - - def connectOutput[R <: OutputRedirection, RO](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RO] - ): ProcessImplIO[RO] = - ProcessImplIO( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - target, - outputRedirectionType.runner(target), - errorRedirection, - runErrorStream, - inputRedirection - ) - - override def connectError[R <: OutputRedirection, RE](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RE] - ): ProcessImplIE[RE] = - ProcessImplIE( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - outputRedirection, - runOutputStream, - target, - outputRedirectionType.runner(target), - inputRedirection - ) - - override protected def selfCopy( - command: String, - arguments: List[String], - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): ProcessImplI = - copy( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - } - - /** Process with no streams bound */ - case class ProcessImpl( - override val command: String, - override val arguments: List[String], - override val workingDirectory: Option[Path], - override val environmentVariables: Map[String, String], - override val removedEnvironmentVariables: Set[String], - override val outputRedirection: OutputRedirection, - override val runOutputStream: java.io.InputStream => ProxIO[Unit], - override val errorRedirection: OutputRedirection, - override val runErrorStream: java.io.InputStream => ProxIO[Unit], - override val inputRedirection: InputRedirection - ) extends Process[Unit, Unit] - with RedirectableOutput[ProcessImplO[*]] - with RedirectableError[ProcessImplE[*]] - with RedirectableInput[ProcessImplI] { - - override type Self = ProcessImpl - - def connectOutput[R <: OutputRedirection, RO](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RO] - ): ProcessImplO[RO] = - ProcessImplO( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - target, - outputRedirectionType.runner(target), - errorRedirection, - runErrorStream, - inputRedirection - ) - - override def connectError[R <: OutputRedirection, RE](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RE] - ): ProcessImplE[RE] = - ProcessImplE( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - outputRedirection, - runOutputStream, - target, - outputRedirectionType.runner(target), - inputRedirection - ) - - override def connectInput(source: InputRedirection): ProcessImplI = - ProcessImplI( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables, - outputRedirection, - runOutputStream, - errorRedirection, - runErrorStream, - source - ) - - override protected def selfCopy( - command: String, - arguments: List[String], - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): ProcessImpl = - copy( - command, - arguments, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - } - - /** Defines a process to be executed - * - * The process by default uses the standard input, output and error - * streams. - * - * @param command - * Command to be executed - * @param arguments - * Arguments for the command - * @return - * the process specification - */ - def apply( - command: String, - arguments: List[String] = List.empty - ): ProcessImpl = - ProcessImpl( - command, - arguments, - workingDirectory = None, - environmentVariables = Map.empty, - removedEnvironmentVariables = Set.empty, - outputRedirection = StdOut(), - runOutputStream = _ => unit, - errorRedirection = StdOut(), - runErrorStream = _ => unit, - inputRedirection = StdIn() - ) - } - -} diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/processgroup.scala b/prox-core/src/main/scala/io/github/vigoo/prox/processgroup.scala deleted file mode 100644 index 61a7eef8..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/processgroup.scala +++ /dev/null @@ -1,725 +0,0 @@ -package io.github.vigoo.prox - -import java.nio.file.Path - -trait ProcessGroupModule { - this: Prox => - - /** Result of an executed process group - * - * @tparam O - * Output type - * @tparam E - * Error output type - */ - trait ProcessGroupResult[+O, +E] { - - /** Per-process exit codes. The key is the original process passed to the - * piping operator - */ - val exitCodes: Map[Process[Unit, Unit], ProxExitCode] - - /** Output of the last process in the group */ - val output: O - - /** Per-process error outputs. The key is the original process passed to the - * piping operator - */ - val errors: Map[Process[Unit, Unit], E] - } - - /** Default implementation of [[ProcessGroupResult]] */ - case class SimpleProcessGroupResult[+O, +E]( - override val exitCodes: Map[Process[Unit, Unit], ProxExitCode], - override val output: O, - override val errors: Map[Process[Unit, Unit], E] - ) extends ProcessGroupResult[O, E] - - /** Representation of a running process group - * - * @tparam O - * Output type - * @tparam E - * Error output type - * @tparam Info - * Runner-specific per-process information type - */ - trait RunningProcessGroup[O, E, +Info] { - val runningOutput: ProxFiber[O] - - /** Runner-specific information about each running process */ - val info: Map[Process[Unit, Unit], Info] - - /** Forcibly terminates all processes in the group. Blocks until it is done. - */ - def kill(): ProxIO[ProcessGroupResult[O, E]] - - /** Terminates all processes in the group. Blocks until it is done. */ - def terminate(): ProxIO[ProcessGroupResult[O, E]] - - /** Blocks until the processes finish running */ - def waitForExit(): ProxIO[ProcessGroupResult[O, E]] - - def mapInfo[I2]( - f: (Process[Unit, Unit], Info) => I2 - ): RunningProcessGroup[O, E, I2] = - new RunningProcessGroup[O, E, I2] { - override val runningOutput: ProxFiber[O] = - RunningProcessGroup.this.runningOutput - override val info: Map[Process[Unit, Unit], I2] = - RunningProcessGroup.this.info.map { case (key, value) => - key -> f(key, value) - } - - override def kill(): ProxIO[ProcessGroupResult[O, E]] = - RunningProcessGroup.this.kill() - - override def terminate(): ProxIO[ProcessGroupResult[O, E]] = - RunningProcessGroup.this.terminate() - - override def waitForExit(): ProxIO[ProcessGroupResult[O, E]] = - RunningProcessGroup.this.waitForExit() - } - } - - /** Process group is two or more processes attached to each other - * - * This implements a pipeline of processes. The input of the first process - * and the output of the last process is redirectable with the - * [[RedirectableInput]] and [[RedirectableOutput]] traits. The processes are - * attached to each other's input/output streams, the pipe between them is - * customizable. - * - * The error streams are also redirectable with the [[RedirectableErrors]] - * trait. - * - * @tparam O - * Output type - * @tparam E - * Error output type - */ - trait ProcessGroup[O, E] - extends ProcessLike - with ProcessGroupConfiguration[O, E] { - val firstProcess: Process[ProxStream[Byte], E] - val innerProcesses: List[Process.UnboundIProcess[ProxStream[Byte], E]] - val lastProcess: Process.UnboundIProcess[O, E] - - val originalProcesses: List[Process[Unit, Unit]] - - /** Starts the process group asynchronously and returns the - * [[RunningProcessGroup]] interface for it - * - * This is the most advanced way to start process groups. See [[start]] and - * [[run]] as alternatives. - * - * @param runner - * The process runner to be used - * @tparam Info - * The runner-specific information about the started processes - * @return - * interface for handling the running process group - */ - def startProcessGroup[Info]()(implicit - runner: ProcessRunner[Info] - ): ProxIO[RunningProcessGroup[O, E, Info]] = - runner.startProcessGroup(this) - - /** Starts the process group asynchronously and returns a closeable fiber - * representing it - * - * Joining the fiber waits for the processes to be terminated. Canceling - * the fiber terminates the processesnormally (with SIGTERM). - * - * @param runner - * The process runner to be used - * @return - * a managed fiber representing the running processes - */ - def start[Info]()(implicit - runner: ProcessRunner[Info] - ): ProxResource[ProxFiber[ProcessGroupResult[O, E]]] = - runner.start(this) - - /** Starts the process group asynchronously and blocks the execution until - * it is finished - * - * @param runner - * The process runner to be used - * @return - * the result of the finished processes - */ - def run[Info]()(implicit - runner: ProcessRunner[Info] - ): ProxIO[ProcessGroupResult[O, E]] = - start().use(_.join) - - /** Applies the given mapper to each process in the group - * - * @param f - * process mapper - * @return - * a new process group with all the processes altered by the mapper - */ - def map(f: ProcessGroup.Mapper[O, E]): Self - } - - trait ProcessGroupConfiguration[O, E] extends ProcessLikeConfiguration { - this: ProcessGroup[O, E] => - - override type Self <: ProcessGroup[O, E] - - private val allProcesses = (firstProcess :: innerProcesses) :+ lastProcess - - override val workingDirectory: Option[Path] = { - val allWorkingDirectories = allProcesses.map(_.workingDirectory).toSet - if (allWorkingDirectories.size == 1) { - allWorkingDirectories.head - } else { - None - } - } - - override val environmentVariables: Map[String, String] = { - allProcesses.map(_.environmentVariables.toSet).reduce(_ intersect _).toMap - } - - override val removedEnvironmentVariables: Set[String] = { - allProcesses.map(_.removedEnvironmentVariables).reduce(_ intersect _) - } - - override protected def applyConfiguration( - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): Self = - map(new ProcessGroup.Mapper[O, E] { - override def mapFirst[P <: Process[ProxStream[Byte], E]]( - process: P - ): P = - ConfigApplication[P]( - process, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - - override def mapInnerWithIdx[ - P <: Process.UnboundIProcess[ProxStream[Byte], E] - ](process: P, idx: Int): P = - ConfigApplication[P]( - process, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - - override def mapLast[P <: Process.UnboundIProcess[O, E]]( - process: P - ): P = - ConfigApplication[P]( - process, - workingDirectory, - environmentVariables, - removedEnvironmentVariables - ) - }) - - class ConfigApplication[P <: ProcessLikeConfiguration] { - // NOTE: Unfortunately we have no proof that P#Self == P so we cast - - private def applyWorkingDirectory( - workingDirectory: Option[Path] - )(process: P): P = - workingDirectory match { - case Some(path) => (process in path).asInstanceOf[P] - case None => process.inInheritedWorkingDirectory().asInstanceOf[P] - } - - private def addEnvironmentVariables( - environmentVariables: Seq[(String, String)] - )(process: P): P = - environmentVariables.foldLeft(process) { case (proc, pair) => - (proc `with` pair).asInstanceOf[P] - } - - private def removeEnvironmentVariables( - environmentVariables: Seq[String] - )(process: P): P = - environmentVariables.foldLeft(process) { case (proc, name) => - (proc without name).asInstanceOf[P] - } - - def apply( - process: P, - workingDirectory: Option[Path], - environmentVariables: Map[String, String], - removedEnvironmentVariables: Set[String] - ): P = - (applyWorkingDirectory(workingDirectory) _ compose - addEnvironmentVariables(environmentVariables.toSeq) compose - removeEnvironmentVariables(removedEnvironmentVariables.toSeq))( - process - ) - } - - object ConfigApplication { - def apply[P <: ProcessLikeConfiguration]: ConfigApplication[P] = - new ConfigApplication[P] - } - - } - - object ProcessGroup { - - /** Mapper functions for altering a process group */ - trait Mapper[O, E] { - def mapFirst[P <: Process[ProxStream[Byte], E]](process: P): P - - def mapInnerWithIdx[P <: Process.UnboundIProcess[ProxStream[Byte], E]]( - process: P, - idx: Int - ): P - - def mapLast[P <: Process.UnboundIProcess[O, E]](process: P): P - } - - /** Process group with bound input, output and error streams */ - case class ProcessGroupImplIOE[O, E]( - override val firstProcess: Process[ProxStream[Byte], E], - override val innerProcesses: List[ - Process.UnboundIProcess[ProxStream[Byte], E] - ], - override val lastProcess: Process.UnboundIProcess[O, E], - override val originalProcesses: List[Process[Unit, Unit]] - ) extends ProcessGroup[O, E] { - - override type Self = ProcessGroupImplIOE[O, E] - - def map(f: ProcessGroup.Mapper[O, E]): ProcessGroupImplIOE[O, E] = { - copy( - firstProcess = f.mapFirst(this.firstProcess), - innerProcesses = this.innerProcesses.zipWithIndex.map { - case (p, idx) => f.mapInnerWithIdx(p, idx + 1) - }, - lastProcess = f.mapLast(this.lastProcess), - originalProcesses - ) - } - } - - /** Process group with bound input and output streams */ - case class ProcessGroupImplIO[O]( - override val firstProcess: Process.UnboundEProcess[ProxStream[Byte]], - override val innerProcesses: List[ - Process.UnboundIEProcess[ProxStream[Byte]] - ], - override val lastProcess: Process.UnboundIEProcess[O], - override val originalProcesses: List[Process[Unit, Unit]] - ) extends ProcessGroup[O, Unit] - with RedirectableErrors[ProcessGroupImplIOE[O, *]] { - - override type Self = ProcessGroupImplIO[O] - - def map(f: ProcessGroup.Mapper[O, Unit]): ProcessGroupImplIO[O] = { - copy( - firstProcess = f.mapFirst(this.firstProcess), - innerProcesses = this.innerProcesses.zipWithIndex.map { - case (p, idx) => f.mapInnerWithIdx(p, idx + 1) - }, - lastProcess = f.mapLast(this.lastProcess), - originalProcesses - ) - } - - override def connectErrors[ - R <: GroupErrorRedirection, - OR <: OutputRedirection, - E - ](target: R)(implicit - groupErrorRedirectionType: GroupErrorRedirectionType.Aux[R, OR, E], - outputRedirectionType: OutputRedirectionType.Aux[OR, E] - ): ProcessGroupImplIOE[O, E] = { - val origs = originalProcesses.reverse.toVector - ProcessGroupImplIOE( - firstProcess.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs.head) - ), - innerProcesses.zipWithIndex.map { case (p, idx) => - p.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs(idx + 1)) - ) - }, - lastProcess.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs.last) - ), - originalProcesses - ) - } - } - - /** Process group with bound input and error streams */ - case class ProcessGroupImplIE[E]( - override val firstProcess: Process[ProxStream[Byte], E], - override val innerProcesses: List[ - Process.UnboundIProcess[ProxStream[Byte], E] - ], - override val lastProcess: Process.UnboundIOProcess[E], - override val originalProcesses: List[Process[Unit, Unit]] - ) extends ProcessGroup[Unit, E] - with RedirectableOutput[ProcessGroupImplIOE[*, E]] { - - override type Self = ProcessGroupImplIE[E] - - def map(f: ProcessGroup.Mapper[Unit, E]): ProcessGroupImplIE[E] = { - copy( - firstProcess = f.mapFirst(this.firstProcess), - innerProcesses = this.innerProcesses.zipWithIndex.map { - case (p, idx) => f.mapInnerWithIdx(p, idx + 1) - }, - lastProcess = f.mapLast(this.lastProcess), - originalProcesses - ) - } - - override def connectOutput[R <: OutputRedirection, RO](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RO] - ): ProcessGroupImplIOE[RO, E] = { - ProcessGroupImplIOE( - firstProcess, - innerProcesses, - lastProcess.connectOutput(target), - originalProcesses - ) - } - } - - /** Process group with bound output and error streams */ - case class ProcessGroupImplOE[O, E]( - override val firstProcess: Process.UnboundIProcess[ProxStream[Byte], E], - override val innerProcesses: List[ - Process.UnboundIProcess[ProxStream[Byte], E] - ], - override val lastProcess: Process.UnboundIProcess[O, E], - override val originalProcesses: List[Process[Unit, Unit]] - ) extends ProcessGroup[O, E] - with RedirectableInput[ProcessGroupImplIOE[O, E]] { - - override type Self = ProcessGroupImplOE[O, E] - - def map(f: ProcessGroup.Mapper[O, E]): ProcessGroupImplOE[O, E] = { - copy( - firstProcess = f.mapFirst(this.firstProcess), - innerProcesses = this.innerProcesses.zipWithIndex.map { - case (p, idx) => f.mapInnerWithIdx(p, idx + 1) - }, - lastProcess = f.mapLast(this.lastProcess), - originalProcesses - ) - } - - override def connectInput( - source: InputRedirection - ): ProcessGroupImplIOE[O, E] = { - ProcessGroupImplIOE( - firstProcess.connectInput(source), - innerProcesses, - lastProcess, - originalProcesses - ) - } - } - - /** Process group with bound input stream */ - case class ProcessGroupImplI( - override val firstProcess: Process.UnboundEProcess[ProxStream[Byte]], - override val innerProcesses: List[ - Process.UnboundIEProcess[ProxStream[Byte]] - ], - override val lastProcess: Process.UnboundProcess, - override val originalProcesses: List[Process[Unit, Unit]] - ) extends ProcessGroup[Unit, Unit] - with RedirectableOutput[ProcessGroupImplIO[*]] - with RedirectableErrors[ProcessGroupImplIE[*]] { - - override type Self = ProcessGroupImplI - - def map(f: ProcessGroup.Mapper[Unit, Unit]): ProcessGroupImplI = { - copy( - firstProcess = f.mapFirst(this.firstProcess), - innerProcesses = this.innerProcesses.zipWithIndex.map { - case (p, idx) => f.mapInnerWithIdx(p, idx + 1) - }, - lastProcess = f.mapLast(this.lastProcess), - originalProcesses - ) - } - - override def connectOutput[R <: OutputRedirection, RO](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RO] - ): ProcessGroupImplIO[RO] = { - ProcessGroupImplIO( - firstProcess, - innerProcesses, - lastProcess.connectOutput(target), - originalProcesses - ) - } - - override def connectErrors[ - R <: GroupErrorRedirection, - OR <: OutputRedirection, - E - ](target: R)(implicit - groupErrorRedirectionType: GroupErrorRedirectionType.Aux[R, OR, E], - outputRedirectionType: OutputRedirectionType.Aux[OR, E] - ): ProcessGroupImplIE[E] = { - val origs = originalProcesses.reverse.toVector - ProcessGroupImplIE( - firstProcess.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs.head) - ), - innerProcesses.zipWithIndex.map { case (p, idx) => - p.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs(idx + 1)) - ) - }, - lastProcess.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs.last) - ), - originalProcesses - ) - } - } - - /** Process group with bound output stream */ - case class ProcessGroupImplO[O]( - override val firstProcess: Process.UnboundIEProcess[ProxStream[Byte]], - override val innerProcesses: List[ - Process.UnboundIEProcess[ProxStream[Byte]] - ], - override val lastProcess: Process.UnboundIEProcess[O], - override val originalProcesses: List[Process[Unit, Unit]] - ) extends ProcessGroup[O, Unit] - with RedirectableInput[ProcessGroupImplIO[O]] - with RedirectableErrors[ProcessGroupImplOE[O, *]] { - - override type Self = ProcessGroupImplO[O] - - def map(f: ProcessGroup.Mapper[O, Unit]): ProcessGroupImplO[O] = { - copy( - firstProcess = f.mapFirst(this.firstProcess), - innerProcesses = this.innerProcesses.zipWithIndex.map { - case (p, idx) => f.mapInnerWithIdx(p, idx + 1) - }, - lastProcess = f.mapLast(this.lastProcess), - originalProcesses - ) - } - - override def connectInput( - source: InputRedirection - ): ProcessGroupImplIO[O] = { - ProcessGroupImplIO( - firstProcess.connectInput(source), - innerProcesses, - lastProcess, - originalProcesses - ) - } - - override def connectErrors[ - R <: GroupErrorRedirection, - OR <: OutputRedirection, - E - ](target: R)(implicit - groupErrorRedirectionType: GroupErrorRedirectionType.Aux[R, OR, E], - outputRedirectionType: OutputRedirectionType.Aux[OR, E] - ): ProcessGroupImplOE[O, E] = { - val origs = originalProcesses.reverse.toVector - ProcessGroupImplOE( - firstProcess.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs.head) - ), - innerProcesses.zipWithIndex.map { case (p, idx) => - p.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs(idx + 1)) - ) - }, - lastProcess.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs.last) - ), - originalProcesses - ) - } - } - - /** Process group with bound error stream */ - case class ProcessGroupImplE[E]( - override val firstProcess: Process.UnboundIProcess[ProxStream[Byte], E], - override val innerProcesses: List[ - Process.UnboundIProcess[ProxStream[Byte], E] - ], - override val lastProcess: Process.UnboundIOProcess[E], - override val originalProcesses: List[Process[Unit, Unit]] - ) extends ProcessGroup[Unit, E] - with RedirectableOutput[ProcessGroupImplOE[*, E]] - with RedirectableInput[ProcessGroupImplIE[E]] { - - override type Self = ProcessGroupImplE[E] - - def map(f: ProcessGroup.Mapper[Unit, E]): ProcessGroupImplE[E] = { - copy( - firstProcess = f.mapFirst(this.firstProcess), - innerProcesses = this.innerProcesses.zipWithIndex.map { - case (p, idx) => f.mapInnerWithIdx(p, idx + 1) - }, - lastProcess = f.mapLast(this.lastProcess), - originalProcesses - ) - } - - override def connectOutput[R <: OutputRedirection, RO](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RO] - ): ProcessGroupImplOE[RO, E] = { - ProcessGroupImplOE( - firstProcess, - innerProcesses, - lastProcess.connectOutput(target), - originalProcesses - ) - } - - override def connectInput( - source: InputRedirection - ): ProcessGroupImplIE[E] = { - ProcessGroupImplIE( - firstProcess.connectInput(source), - innerProcesses, - lastProcess, - originalProcesses - ) - } - } - - /** Process group with unbound input, output and error streams */ - case class ProcessGroupImpl( - override val firstProcess: Process.UnboundIEProcess[ProxStream[Byte]], - override val innerProcesses: List[ - Process.UnboundIEProcess[ProxStream[Byte]] - ], - override val lastProcess: Process.UnboundProcess, - override val originalProcesses: List[Process[Unit, Unit]] - ) extends ProcessGroup[Unit, Unit] - with RedirectableOutput[ProcessGroupImplO[*]] - with RedirectableInput[ProcessGroupImplI] - with RedirectableErrors[ProcessGroupImplE[*]] { - - override type Self = ProcessGroupImpl - - def pipeInto( - other: Process.UnboundProcess, - channel: ProxPipe[Byte, Byte] - ): ProcessGroupImpl = { - val pl1 = lastProcess.connectOutput( - OutputStreamThroughPipe( - channel, - (stream: ProxStream[Byte]) => pure(stream) - ) - ) - - copy( - innerProcesses = pl1 :: innerProcesses, - lastProcess = other, - originalProcesses = other :: originalProcesses - ) - } - - def |(other: Process.UnboundProcess): ProcessGroupImpl = - pipeInto(other, identityPipe) - - def via( - channel: ProxPipe[Byte, Byte] - ): PipeBuilderSyntax[ProcessGroupImpl] = - new PipeBuilderSyntax( - new PipeBuilder[ProcessGroupImpl] { - override def build( - other: Process.UnboundProcess, - channel: ProxPipe[Byte, Byte] - ): ProcessGroupImpl = - ProcessGroupImpl.this.pipeInto(other, channel) - }, - channel - ) - - def map(f: ProcessGroup.Mapper[Unit, Unit]): ProcessGroupImpl = { - copy( - firstProcess = f.mapFirst(this.firstProcess), - innerProcesses = this.innerProcesses.zipWithIndex.map { - case (p, idx) => f.mapInnerWithIdx(p, idx + 1) - }, - lastProcess = f.mapLast(this.lastProcess), - originalProcesses - ) - } - - override def connectInput(source: InputRedirection): ProcessGroupImplI = - ProcessGroupImplI( - firstProcess.connectInput(source), - innerProcesses, - lastProcess, - originalProcesses - ) - - override def connectErrors[ - R <: GroupErrorRedirection, - OR <: OutputRedirection, - E - ](target: R)(implicit - groupErrorRedirectionType: GroupErrorRedirectionType.Aux[R, OR, E], - outputRedirectionType: OutputRedirectionType.Aux[OR, E] - ): ProcessGroupImplE[E] = { - val origs = originalProcesses.reverse.toVector - ProcessGroupImplE( - firstProcess.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs.head) - ), - innerProcesses.zipWithIndex.map { case (p, idx) => - p.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs(idx + 1)) - ) - }, - lastProcess.connectError( - groupErrorRedirectionType - .toOutputRedirectionType(target, origs.last) - ), - originalProcesses - ) - } - - override def connectOutput[R <: OutputRedirection, RO](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, RO] - ): ProcessGroupImplO[RO] = { - ProcessGroupImplO( - firstProcess, - innerProcesses, - lastProcess.connectOutput(target), - originalProcesses - ) - } - } - - } - -} diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/redirection.scala b/prox-core/src/main/scala/io/github/vigoo/prox/redirection.scala deleted file mode 100644 index 801092c3..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/redirection.scala +++ /dev/null @@ -1,1063 +0,0 @@ -package io.github.vigoo.prox - -import java.io -import java.nio.file.Path - -trait RedirectionModule { - this: Prox => - - /** The capability to redirect the output of a process or a process group - * - * @tparam P - * Self type without the [[RedirectableOutput]] capability - */ - trait RedirectableOutput[+P[_] <: ProcessLike] { - - /** 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. - * - * @param target - * Redirection target - * @param outputRedirectionType - * Helper for dependent output type - * @tparam R - * Output redirection type - * @tparam O - * Output type - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def connectOutput[R <: OutputRedirection, O](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, O] - ): P[O] - - /** Redirects the output to a sink. - * - * The process output type will be [[Unit]]. An alias for [[toSink]] - * - * @param sink - * Target sink - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def >(sink: ProxSink[Byte]): P[Unit] = - toSink(sink) - - /** Redirects the output to a sink. - * - * The process output type will be [[Unit]]. An alias for [[>]] - * - * @param sink - * Target sink - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def toSink(sink: ProxSink[Byte]): P[Unit] = - connectOutput(OutputStreamToSink(sink)) - - /** 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]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe. Must have a monoid instance. - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def >#[O: ProxMonoid](pipe: ProxPipe[Byte, O]): P[O] = - toFoldMonoid(pipe) - - /** 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 [[>#]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe. Must have a monoid instance. - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def toFoldMonoid[O: ProxMonoid](pipe: ProxPipe[Byte, O]): P[O] = - connectOutput( - OutputStreamThroughPipe(pipe, (s: ProxStream[O]) => s.foldMonoid) - ) - - /** 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]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def >?[O](pipe: ProxPipe[Byte, O]): P[Vector[O]] = - toVector(pipe) - - /** 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 [[>?]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def toVector[O](pipe: ProxPipe[Byte, O]): P[Vector[O]] = - connectOutput( - OutputStreamThroughPipe(pipe, (s: ProxStream[O]) => s.toVector) - ) - - /** Redirects the output to a pipe and drains it regardless of its output - * type. - * - * The process output type will be [[Unit]]. - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def drainOutput[O](pipe: ProxPipe[Byte, O]): P[Unit] = - connectOutput( - OutputStreamThroughPipe(pipe, (s: ProxStream[O]) => s.drain) - ) - - /** Redirects the output to a pipe and folds it with a custom function. - * - * The process output type will be R. - * - * @param pipe - * Target pipe - * @param init - * The initial value for the fold - * @param fn - * The fold function - * @tparam O - * Output type of the pipe - * @tparam R - * Result type of the fold - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def foldOutput[O, R]( - pipe: ProxPipe[Byte, O], - init: R, - fn: (R, O) => R - ): P[R] = - connectOutput( - OutputStreamThroughPipe(pipe, (s: ProxStream[O]) => s.fold(init, (fn))) - ) - - /** Redirects the output to a file natively - * - * An alias for [[toFile]] - * - * @param path - * Target file path - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def >(path: Path): P[Unit] = - toFile(path) - - /** Redirects the output to a file natively - * - * An alias for [[>]] - * - * @param path - * Target file path - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def toFile(path: Path): P[Unit] = - connectOutput(OutputFile(path, append = false)) - - /** Redirects the output to a file natively in append mode - * - * An alias for [[appendToFile]] - * - * @param path - * Target file path - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def >>(path: Path): P[Unit] = - appendToFile(path) - - /** Redirects the output to a file natively in append mode - * - * An alias for [[>>]] - * - * @param path - * Target file path - * @return - * Returns a new process or process group with its output redirected and - * its output redirection capability removed. - */ - def appendToFile(path: Path): P[Unit] = - connectOutput(OutputFile(path, append = true)) - } - - /** The capability to redirect the error output of a process - * - * @tparam P - * Self type without the [[RedirectableError]] capability - */ - trait RedirectableError[+P[_] <: 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. - * - * @param target - * Redirection target - * @param outputRedirectionType - * Helper for dependent error output type - * @tparam R - * Error output redirection type - * @tparam E - * Error output type - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def connectError[R <: OutputRedirection, E](target: R)(implicit - outputRedirectionType: OutputRedirectionType.Aux[R, E] - ): P[E] - - /** Redirects the error output to a sink. - * - * The process error output type will be [[Unit]]. An alias for - * [[errorToSink]] - * - * @param sink - * Target sink - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def !>(sink: ProxSink[Byte]): P[Unit] = - errorToSink(sink) - - /** Redirects the error output to a sink. - * - * The process error output type will be [[Unit]]. An alias for [[!>]] - * - * @param sink - * Target sink - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def errorToSink(sink: ProxSink[Byte]): P[Unit] = - connectError(OutputStreamToSink(sink)) - - /** 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]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe. Must have a monoid instance. - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def !>#[O: ProxMonoid](pipe: ProxPipe[Byte, O]): P[O] = - errorToFoldMonoid(pipe) - - /** 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 [[!>#]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe. Must have a monoid instance. - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def errorToFoldMonoid[O: ProxMonoid](pipe: ProxPipe[Byte, O]): P[O] = - connectError( - OutputStreamThroughPipe(pipe, (s: ProxStream[O]) => s.foldMonoid) - ) - - /** 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]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def !>?[O](pipe: ProxPipe[Byte, O]): P[Vector[O]] = - errorToVector(pipe) - - /** 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 [[!>?]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def errorToVector[O](pipe: ProxPipe[Byte, O]): P[Vector[O]] = - connectError( - OutputStreamThroughPipe(pipe, (s: ProxStream[O]) => s.toVector) - ) - - /** Redirects the error output to a pipe and drains it regardless of its - * output type. - * - * The process error output type will be [[Unit]]. - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def drainError[O](pipe: ProxPipe[Byte, O]): P[Unit] = - connectError(OutputStreamThroughPipe(pipe, (s: ProxStream[O]) => s.drain)) - - /** Redirects the error output to a pipe and folds it with a custom - * function. - * - * The process error output type will be R. - * - * @param pipe - * Target pipe - * @param init - * The initial value for the fold - * @param fn - * The fold function - * @tparam O - * Output type of the pipe - * @tparam R - * Result type of the fold - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def foldError[O, R]( - pipe: ProxPipe[Byte, O], - init: R, - fn: (R, O) => R - ): P[R] = - connectError( - OutputStreamThroughPipe(pipe, (s: ProxStream[O]) => s.fold(init, fn)) - ) - - /** Redirects the error output to a file natively - * - * An alias for [[errorToFile]] - * - * @param path - * Target file path - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def !>(path: Path): P[Unit] = - errorToFile(path) - - /** Redirects the error output to a file natively - * - * An alias for [[!>]] - * - * @param path - * Target file path - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def errorToFile(path: Path): P[Unit] = - connectError(OutputFile(path, append = false)) - - /** Redirects the error output to a file natively in append mode - * - * An alias for [[appendErrorToFile]] - * - * @param path - * Target file path - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def !>>(path: Path): P[Unit] = - appendErrorToFile(path) - - /** Redirects the error output to a file natively in append mode - * - * An alias for [[!>>]] - * - * @param path - * Target file path - * @return - * Returns a new process with its error output redirected and its error - * redirection capability removed. - */ - def appendErrorToFile(path: Path): P[Unit] = - connectError(OutputFile(path, append = true)) - } - - /** The capability to redirect all the error outputs simultaneously of a - * process group - * - * @tparam P - * Self type without the [[RedirectableErrors]] capability - */ - trait RedirectableErrors[+P[_] <: ProcessGroup[_, _]] { - - /** A more advanced interface for customizing the redirection per process */ - lazy val customizedPerProcess: RedirectableErrors.CustomizedPerProcess[P] = - new RedirectableErrors.CustomizedPerProcess[P] { - override def connectErrors[ - R <: GroupErrorRedirection, - OR <: OutputRedirection, - E - ](target: R)(implicit - groupErrorRedirectionType: GroupErrorRedirectionType.Aux[R, OR, E], - outputRedirectionType: OutputRedirectionType.Aux[OR, E] - ): P[E] = - RedirectableErrors.this.connectErrors(target) - } - - /** The low level operation to attach an error output to all the processes - * in the group. - * - * Use one of the other methods of this trait or the advanced interface - * represented by [[customizedPerProcess]] for convenience. - * - * This is the place where the process group's error output type gets - * calculated using the [[GroupErrorRedirectionType]] and - * [[OutputRedirectionType]] type classes. - * - * @param target - * Redirection target - * @param groupErrorRedirectionType - * Helper for dependent error output type - * @param outputRedirectionType - * Helper for dependent error output type - * @tparam R - * Error output grouped redirection type - * @tparam OR - * Error output redirection type - * @tparam E - * Error output type - * @return - * Returns a new process group with all the error streams redirected and - * the error redirection capability removed. - */ - def connectErrors[R <: GroupErrorRedirection, OR <: OutputRedirection, E]( - target: R - )(implicit - groupErrorRedirectionType: GroupErrorRedirectionType.Aux[R, OR, E], - outputRedirectionType: OutputRedirectionType.Aux[OR, E] - ): P[E] - - /** Redirects the error outputs to a sink. - * - * The process error output type will be [[Unit]]. An alias for - * [[errorsToSink]] - * - * @param sink - * Target sink - * @return - * Returns a new process group with all the error streams redirected and - * the error redirection capability removed. - */ - def !>(sink: ProxSink[Byte]): P[Unit] = - errorsToSink(sink) - - /** Redirects the error outputs to a sink. - * - * The process error output type will be [[Unit]]. An alias for [[!>]] - * - * @param sink - * Target sink - * @return - * Returns a new process group with all the error streams redirected and - * the error redirection capability removed. - */ - def errorsToSink(sink: ProxSink[Byte]): P[Unit] = - customizedPerProcess.errorsToSink(_ => sink) - - /** Redirects the error outputs 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 [[errorsToFoldMonoid]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe. Must have a monoid instance. - * @return - * Returns a new process group with all the error streams redirected and - * the error redirection capability removed. - */ - def !>#[O: ProxMonoid](pipe: ProxPipe[Byte, O]): P[O] = - errorsToFoldMonoid(pipe) - - /** Redirects the error outputs 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 [[!>#]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe. Must have a monoid instance. - * @return - * Returns a new process group with all the error streams redirected and - * the error redirection capability removed. - */ - def errorsToFoldMonoid[O: ProxMonoid](pipe: ProxPipe[Byte, O]): P[O] = - customizedPerProcess.errorsToFoldMonoid(_ => pipe) - - /** Redirects the error outputs 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 [[errorsToVector]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe - * @return - * Returns a new process group with all the error streams redirected and - * the error redirection capability removed. - */ - def !>?[O](pipe: ProxPipe[Byte, O]): P[Vector[O]] = - errorsToVector(pipe) - - /** Redirects the error outputs 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 [[!>?]] - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe - * @return - * Returns a new process group with all the error streams redirected and - * the error redirection capability removed. - */ - def errorsToVector[O](pipe: ProxPipe[Byte, O]): P[Vector[O]] = - customizedPerProcess.errorsToVector(_ => pipe) - - /** Redirects the error outputs to a pipe and drains it regardless of its - * output type. - * - * The process error output type will be [[Unit]]. - * - * @param pipe - * Target pipe - * @tparam O - * Output type of the pipe - * @return - * Returns a new process group with all the error streams redirected and - * the error redirection capability removed. - */ - def drainErrors[O](pipe: ProxPipe[Byte, O]): P[Unit] = - customizedPerProcess.drainErrors(_ => pipe) - - /** Redirects the error outputs to a pipe and folds it with a custom - * function. - * - * The process error output type will be R. - * - * @param pipe - * Target pipe - * @param init - * The initial value for the fold - * @param fn - * The fold function - * @tparam O - * Output type of the pipe - * @tparam R - * Result type of the fold - * @return - * Returns a new process group with all the error streams redirected and - * the error redirection capability removed. - */ - def foldErrors[O, R]( - pipe: ProxPipe[Byte, O], - init: R, - fn: (R, O) => R - ): P[R] = - customizedPerProcess.foldErrors(_ => pipe, init, fn) - } - - object RedirectableErrors { - - /** Advanced version of the [[RedirectableErrors]] interface enabling - * per-process customizations. - * - * @tparam P - * Self type without [[RedirectableErrors]] - */ - trait CustomizedPerProcess[+P[_] <: ProcessGroup[_, _]] { - - /** See [[RedirectableErrors.connectErrors]] */ - def connectErrors[R <: GroupErrorRedirection, OR <: OutputRedirection, E]( - target: R - )(implicit - groupErrorRedirectionType: GroupErrorRedirectionType.Aux[R, OR, E], - outputRedirectionType: OutputRedirectionType.Aux[OR, E] - ): P[E] - - /** Redirects the error outputs to a sink. - * - * The process error output type will be [[Unit]]. - * - * @param sinkFn - * Function to get a sink for each process in the group - * @return - * Returns a new process group with all the error streams redirected - * and the error redirection capability removed. - */ - def errorsToSink(sinkFn: Process[_, _] => ProxSink[Byte]): P[Unit] = - connectErrors(AllCapturedToSink(sinkFn)) - - /** Redirects the error outputs 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. - * - * @param pipeFn - * A function to get a pipe for each process in the group - * @tparam O - * Output type of the pipe. Must have a monoid instance. - * @return - * Returns a new process group with all the error streams redirected - * and the error redirection capability removed. - */ - def errorsToFoldMonoid[O: ProxMonoid]( - pipeFn: Process[_, _] => ProxPipe[Byte, O] - ): P[O] = - connectErrors( - AllCapturedThroughPipe(pipeFn, (s: ProxStream[O]) => s.foldMonoid) - ) - - /** Redirects the error outputs 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. - * - * @param pipeFn - * A function to get a pipe for each process in the group - * @tparam O - * Output type of the pipe - * @return - * Returns a new process group with all the error streams redirected - * and the error redirection capability removed. - */ - def errorsToVector[O]( - pipeFn: Process[_, _] => ProxPipe[Byte, O] - ): P[Vector[O]] = - connectErrors( - AllCapturedThroughPipe(pipeFn, (s: ProxStream[O]) => s.toVector) - ) - - /** Redirects the error outputs to a pipe and drains it regardless of its - * output type. - * - * The process error output type will be [[Unit]]. - * - * @param pipeFn - * A function to get a pipe for each process in the group - * @tparam O - * Output type of the pipe - * @return - * Returns a new process group with all the error streams redirected - * and the error redirection capability removed. - */ - def drainErrors[O](pipeFn: Process[_, _] => ProxPipe[Byte, O]): P[Unit] = - connectErrors( - AllCapturedThroughPipe(pipeFn, (s: ProxStream[O]) => s.drain) - ) - - /** Redirects the error outputs to a pipe and folds it with a custom - * function. - * - * The process error output type will be R. - * - * @param pipeFn - * A function to get a pipe for each process in the group - * @param init - * The initial value for the fold - * @param fn - * The fold function - * @tparam O - * Output type of the pipe - * @tparam R - * Result type of the fold - * @return - * Returns a new process group with all the error streams redirected - * and the error redirection capability removed. - */ - def foldErrors[O, R]( - pipeFn: Process[_, _] => ProxPipe[Byte, O], - init: R, - fn: (R, O) => R - ): P[R] = - connectErrors( - AllCapturedThroughPipe(pipeFn, (s: ProxStream[O]) => s.fold(init, fn)) - ) - - /** Redirects the error outputs to one file per process - * - * The process error output type will be [[Unit]]. - * - * @param pathFn - * A function to get a file path for each process in the group - * @return - * Returns a new process group with all the error streams redirected - * and the error redirection capability removed. - */ - def errorsToFile(pathFn: Process[_, _] => Path): P[Unit] = - connectErrors(AllToFile(pathFn, append = false)) - - /** Redirects the error outputs to one file per process in append mode - * - * The process error output type will be [[Unit]]. - * - * @param pathFn - * A function to get a file path for each process in the group - * @return - * Returns a new process group with all the error streams redirected - * and the error redirection capability removed. - */ - def appendErrorsToFile(pathFn: Process[_, _] => Path): P[Unit] = - connectErrors(AllToFile(pathFn, append = true)) - } - - } - - /** The capability to redirect the input of a process or process group - * - * @tparam P - */ - trait RedirectableInput[+P <: ProcessLike] { - - /** The low level method to attach an input to a process or process group. - * - * Use the other methods in this trait for convenience. - * - * @param source - * Redirection source - * @return - * A new process or process group with the input redirected and the input - * redirection capability removed. - */ - def connectInput(source: InputRedirection): P - - /** Feed the process input from a file natively. - * - * An alias for [[fromFile]]. - * - * @param path - * Path to the file - * @return - * A new process or process group with the input redirected and the input - * redirection capability removed. - */ - def <(path: Path): P = - fromFile(path) - - /** Feed the process input from a file natively. - * - * An alias for [[<]]. - * - * @param path - * Path to the file - * @return - * A new process or process group with the input redirected and the input - * redirection capability removed. - */ - def fromFile(path: Path): P = - connectInput(InputFile(path)) - - /** Feed the process input from a byte stream. - * - * An alias for [[fromStream]]. - * - * @param stream - * Input stream - * @return - * A new process or process group with the input redirected and the input - * redirection capability removed. - */ - def <(stream: ProxStream[Byte]): P = - fromStream(stream, flushChunks = false) - - /** Feed the process input from a byte stream with flushing per chunks - * enabled. - * - * An alias for [[fromStream]]. - * - * @param stream - * Input stream - * @return - * A new process or process group with the input redirected and the input - * redirection capability removed. - */ - def !<(stream: ProxStream[Byte]): P = - fromStream(stream, flushChunks = true) - - /** Feed the process input from a byte stream. - * - * An alias for [[<]] and [[!<]]. - * - * @param stream - * Input stream - * @param flushChunks - * Flush the process input stream after each chunk - * @return - * A new process or process group with the input redirected and the input - * redirection capability removed. - */ - def fromStream(stream: ProxStream[Byte], flushChunks: Boolean): P = - connectInput(InputStream(stream, flushChunks)) - } - - /** Supported output redirection types. Should not be used directly, see the - * redirection traits instead. - */ - sealed trait OutputRedirection - - case class StdOut() extends OutputRedirection - - case class OutputFile(path: Path, append: Boolean) extends OutputRedirection - - case class OutputStreamThroughPipe[O, OR]( - pipe: ProxPipe[Byte, O], - runner: ProxStream[O] => ProxIO[OR], - chunkSize: Int = 8192 - ) extends OutputRedirection - - case class OutputStreamToSink(sink: ProxSink[Byte], chunkSize: Int = 8192) - extends OutputRedirection - - /** Supported process group error redirection types. Should not be used - * directly, see the redirection traits instead. - */ - sealed trait GroupErrorRedirection - - case class AllToStdErr() extends GroupErrorRedirection - - case class AllToFile(pathFn: Process[_, _] => Path, append: Boolean) - extends GroupErrorRedirection - - case class AllCapturedThroughPipe[O, OR]( - pipeFn: Process[_, _] => ProxPipe[Byte, O], - runner: ProxStream[O] => ProxIO[OR], - chunkSize: Int = 8192 - ) extends GroupErrorRedirection - - case class AllCapturedToSink( - sinkFn: Process[_, _] => ProxSink[Byte], - chunkSize: Int = 8192 - ) extends GroupErrorRedirection - - /** Supported input redirection types. Should not be used directly, see the - * redirection traits instead. - */ - sealed trait InputRedirection - - case class StdIn() extends InputRedirection - - case class InputFile(path: Path) extends InputRedirection - - case class InputStream(stream: ProxStream[Byte], flushChunks: Boolean) - extends InputRedirection - - /** Helper type class for output and error redirection dependent typing */ - trait OutputRedirectionType[R] { - type Out - - def runner(of: R)(nativeStream: java.io.InputStream): ProxIO[Out] - } - - object OutputRedirectionType { - type Aux[R, O] = OutputRedirectionType[R] { - type Out = O - } - - implicit def outputRedirectionTypeOfStdOut: Aux[StdOut, Unit] = - new OutputRedirectionType[StdOut] { - override type Out = Unit - - override def runner(of: StdOut)( - nativeStream: java.io.InputStream - ): ProxIO[Unit] = unit - } - - implicit def outputRedirectionTypeOfFile: Aux[OutputFile, Unit] = - new OutputRedirectionType[OutputFile] { - override type Out = Unit - - override def runner(of: OutputFile)( - nativeStream: java.io.InputStream - ): ProxIO[Unit] = unit - } - - implicit def outputRedirectionTypeOfStreamThroughPipe[O, OR] - : Aux[OutputStreamThroughPipe[O, OR], OR] = - new OutputRedirectionType[OutputStreamThroughPipe[O, OR]] { - override type Out = OR - - override def runner( - of: OutputStreamThroughPipe[O, OR] - )(nativeStream: java.io.InputStream): ProxIO[OR] = { - of.runner( - fromJavaInputStream(nativeStream, of.chunkSize).through(of.pipe) - ) - } - } - - implicit def outputRedirectionTypeOfStreamToSink[O] - : Aux[OutputStreamToSink, Unit] = - new OutputRedirectionType[OutputStreamToSink] { - override type Out = Unit - - override def runner(of: OutputStreamToSink)( - nativeStream: io.InputStream - ): ProxIO[Unit] = - fromJavaInputStream(nativeStream, of.chunkSize).run(of.sink) - } - } - - /** Helper type class for process group error redirection dependent typing */ - trait GroupErrorRedirectionType[R] { - type Out - type OutputR <: OutputRedirection - - def toOutputRedirectionType(redir: R, process: Process[_, _]): OutputR - } - - object GroupErrorRedirectionType { - type Aux[R, OR, O] = GroupErrorRedirectionType[R] { - type Out = O - type OutputR = OR - } - - implicit def groupErrorRedirectionTypeOfStdErr - : Aux[AllToStdErr, StdOut, Unit] = - new GroupErrorRedirectionType[AllToStdErr] { - override type Out = Unit - override type OutputR = StdOut - - override def toOutputRedirectionType( - redir: AllToStdErr, - process: Process[_, _] - ): StdOut = StdOut() - } - - implicit def groupErrorRedirectionTypeOfFile - : Aux[AllToFile, OutputFile, Unit] = - new GroupErrorRedirectionType[AllToFile] { - override type Out = Unit - override type OutputR = OutputFile - - override def toOutputRedirectionType( - redir: AllToFile, - process: Process[_, _] - ): OutputFile = OutputFile(redir.pathFn(process), redir.append) - } - - implicit def groupErrorRedirectionTypeOfStreamThroughPipe[O, OR]: Aux[ - AllCapturedThroughPipe[O, OR], - OutputStreamThroughPipe[O, OR], - OR - ] = new GroupErrorRedirectionType[AllCapturedThroughPipe[O, OR]] { - override type Out = OR - override type OutputR = OutputStreamThroughPipe[O, OR] - - override def toOutputRedirectionType( - redir: AllCapturedThroughPipe[O, OR], - process: Process[_, _] - ): OutputStreamThroughPipe[O, OR] = - OutputStreamThroughPipe( - redir.pipeFn(process), - redir.runner, - redir.chunkSize - ) - } - - implicit val groupErrorRedirectionTypeOfStreamToSink - : Aux[AllCapturedToSink, OutputStreamToSink, Unit] = - new GroupErrorRedirectionType[AllCapturedToSink] { - override type Out = Unit - override type OutputR = OutputStreamToSink - - override def toOutputRedirectionType( - redir: AllCapturedToSink, - process: Process[_, _] - ): OutputStreamToSink = - OutputStreamToSink(redir.sinkFn(process), redir.chunkSize) - } - } - -} diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/runner.scala b/prox-core/src/main/scala/io/github/vigoo/prox/runner.scala deleted file mode 100644 index 93272227..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/runner.scala +++ /dev/null @@ -1,375 +0,0 @@ -package io.github.vigoo.prox - -import java.lang.{Process as JvmProcess} -import scala.jdk.CollectionConverters.* - -trait ProcessRunnerModule { - this: Prox => - - /** Interface for running processes and process groups - * - * The default implementation is [[JVMProcessRunner]] - * - * @tparam Info - * The type of information provided for a started process - */ - trait ProcessRunner[Info] { - - /** Starts the process asynchronously and returns the [[RunningProcess]] - * interface for it - * - * @param process - * The process to be started - * @tparam O - * Output type - * @tparam E - * Error output type - * @return - * interface for handling the running process - */ - def startProcess[O, E]( - process: Process[O, E] - ): ProxIO[RunningProcess[O, E, Info]] - - /** Starts the process asynchronously and returns a managed fiber - * representing it - * - * Joining the fiber means waiting until the process gets terminated. - * Cancelling the fiber terminates the process. - * - * @param process - * The process to be started - * @tparam O - * Output type - * @tparam E - * Error output type - * @return - * interface for handling the running process - */ - def start[O, E]( - process: Process[O, E] - ): ProxResource[ProxFiber[ProcessResult[O, E]]] = { - val run = startFiber(bracket(startProcess(process)) { runningProcess => - runningProcess.waitForExit() - } { - case (_, Completed) => - unit - case (_, Failed(reason)) => - raiseError(reason.toSingleError) - case (runningProcess, Canceled) => - runningProcess.terminate().map(_ => ()) - }) - - makeResource(run, _.cancel) - } - - /** Starts a process group asynchronously and returns an interface for them - * - * @param processGroup - * The process group to start - * @tparam O - * Output type - * @tparam E - * Error output type - * @return - * interface for handling the running process group - */ - def startProcessGroup[O, E]( - processGroup: ProcessGroup[O, E] - ): ProxIO[RunningProcessGroup[O, E, Info]] - - /** Starts the process group asynchronously and returns a managed fiber - * representing it - * - * Joining the fiber means waiting until the process gets terminated. - * Cancelling the fiber terminates the process. - * - * @param processGroup - * The process group to be started - * @tparam O - * Output type - * @tparam E - * Error output type - * @return - * interface for handling the running process - */ - def start[O, E]( - processGroup: ProcessGroup[O, E] - ): ProxResource[ProxFiber[ProcessGroupResult[O, E]]] = { - val run = - startFiber( - bracket(startProcessGroup(processGroup)) { runningProcess => - runningProcess.waitForExit() - } { - case (_, Completed) => - unit - case (_, Failed(reason)) => - raiseError(reason.toSingleError) - case (runningProcess, Canceled) => - runningProcess.terminate().map(_ => ()) - } - ) - - makeResource(run, _.cancel) - } - } - - class JVMProcessInfo() - - /** Default implementation of [[RunningProcess]] using the Java process API */ - class JVMRunningProcess[O, E, +Info <: JVMProcessInfo]( - val nativeProcess: JvmProcess, - override val runningInput: ProxFiber[Unit], - override val runningOutput: ProxFiber[O], - override val runningError: ProxFiber[E], - override val info: Info - ) extends RunningProcess[O, E, Info] { - - def isAlive: ProxIO[Boolean] = - effect(nativeProcess.isAlive, FailedToQueryState.apply) - - def kill(): ProxIO[ProcessResult[O, E]] = - effect(nativeProcess.destroyForcibly(), FailedToDestroy.apply).flatMap( - _ => waitForExit() - ) - - def terminate(): ProxIO[ProcessResult[O, E]] = - effect(nativeProcess.destroy(), FailedToDestroy.apply).flatMap(_ => - waitForExit() - ) - - def waitForExit(): ProxIO[ProcessResult[O, E]] = { - for { - exitCode <- blockingEffect( - nativeProcess.waitFor(), - FailedToWaitForExit.apply - ) - _ <- runningInput.join - output <- runningOutput.join - error <- runningError.join - } yield SimpleProcessResult(exitCodeFromInt(exitCode), output, error) - } - } - - /** Default implementation of [[RunningProcessGroup]] using the Java process - * API - */ - class JVMRunningProcessGroup[O, E, +Info <: JVMProcessInfo]( - runningProcesses: Map[Process[Unit, Unit], RunningProcess[_, E, Info]], - override val runningOutput: ProxFiber[O] - ) extends RunningProcessGroup[O, E, Info] { - - override val info: Map[Process[Unit, Unit], Info] = - runningProcesses.map { case (key, value) => (key, value.info) } - - def kill(): ProxIO[ProcessGroupResult[O, E]] = - traverse(runningProcesses.values.toList)(_.kill().map(_ => ())).flatMap( - _ => waitForExit() - ) - - def terminate(): ProxIO[ProcessGroupResult[O, E]] = - traverse(runningProcesses.values.toList)(_.terminate().map(_ => ())) - .flatMap(_ => waitForExit()) - - def waitForExit(): ProxIO[ProcessGroupResult[O, E]] = - for { - results <- traverse(runningProcesses.toList) { case (spec, rp) => - rp.waitForExit().map((result: ProcessResult[_, E]) => spec -> result) - } - lastOutput <- runningOutput.join - exitCodes = results.map { case (proc, result) => - proc -> result.exitCode - }.toMap - errors = results.map { case (proc, result) => - proc -> result.error - }.toMap - } yield SimpleProcessGroupResult(exitCodes, lastOutput, errors) - } - - /** Default implementation of [[ProcessRunner]] using the Java process API */ - abstract class JVMProcessRunnerBase[Info <: JVMProcessInfo] - extends ProcessRunner[Info] { - - import JVMProcessRunnerBase._ - - override def startProcess[O, E]( - process: Process[O, E] - ): ProxIO[RunningProcess[O, E, Info]] = { - val builder = withEnvironmentVariables( - process, - withWorkingDirectory( - process, - new ProcessBuilder((process.command :: process.arguments).asJava) - ) - ) - - builder.redirectOutput( - ouptutRedirectionToNative(process.outputRedirection) - ) - builder.redirectError(ouptutRedirectionToNative(process.errorRedirection)) - builder.redirectInput(inputRedirectionToNative(process.inputRedirection)) - - for { - nativeProcess <- effect(builder.start(), FailedToStartProcess.apply) - processInfo <- getProcessInfo(nativeProcess) - nativeOutputStream <- effect( - nativeProcess.getInputStream, - UnknownProxError.apply - ) - nativeErrorStream <- effect( - nativeProcess.getErrorStream, - UnknownProxError.apply - ) - - inputStream = runInputStream(process, nativeProcess) - runningInput <- startFiber(inputStream) - runningOutput <- startFiber(process.runOutputStream(nativeOutputStream)) - runningError <- startFiber(process.runErrorStream(nativeErrorStream)) - } yield new JVMRunningProcess( - nativeProcess, - runningInput, - runningOutput, - runningError, - processInfo - ) - } - - protected def getProcessInfo(process: JvmProcess): ProxIO[Info] - - private def connectAndStartProcesses[E]( - firstProcess: Process[ProxStream[Byte], E] - with RedirectableInput[Process[ProxStream[Byte], E]], - previousOutput: ProxStream[Byte], - remainingProcesses: List[ - Process[ProxStream[Byte], E] - with RedirectableInput[Process[ProxStream[Byte], E]] - ], - startedProcesses: List[RunningProcess[_, E, Info]] - ): ProxIO[(List[RunningProcess[_, E, Info]], ProxStream[Byte])] = { - startProcess( - firstProcess.connectInput( - InputStream(previousOutput, flushChunks = false) - ) - ).flatMap { first => - first.runningOutput.join.flatMap { firstOutput => - val updatedStartedProcesses = first :: startedProcesses - remainingProcesses match { - case nextProcess :: rest => - connectAndStartProcesses( - nextProcess, - firstOutput, - rest, - updatedStartedProcesses - ) - case Nil => - pure((updatedStartedProcesses.reverse, firstOutput)) - } - } - } - } - - override def startProcessGroup[O, E]( - processGroup: ProcessGroup[O, E] - ): ProxIO[RunningProcessGroup[O, E, Info]] = - for { - first <- startProcess(processGroup.firstProcess) - firstOutput <- first.runningOutput.join - innerResult <- - if (processGroup.innerProcesses.isEmpty) { - pure((List.empty, firstOutput)) - } else { - val inner = processGroup.innerProcesses.reverse - connectAndStartProcesses( - inner.head, - firstOutput, - inner.tail, - List.empty - ) - } - (inner, lastInput) = innerResult - last <- startProcess( - processGroup.lastProcess.connectInput( - InputStream(lastInput, flushChunks = false) - ) - ) - runningProcesses = processGroup.originalProcesses.reverse - .zip((first :: inner) :+ last) - .toMap - } yield new JVMRunningProcessGroup[O, E, Info]( - runningProcesses, - last.runningOutput - ) - - private def runInputStream[O, E]( - process: Process[O, E], - nativeProcess: JvmProcess - ): ProxIO[Unit] = { - process.inputRedirection match { - case StdIn() => unit - case InputFile(_) => unit - case InputStream(stream, flushChunks) => - drainToJavaOutputStream( - stream, - nativeProcess.getOutputStream, - flushChunks - ) - } - } - } - - object JVMProcessRunnerBase { - def withWorkingDirectory[O, E]( - process: Process[O, E], - builder: ProcessBuilder - ): ProcessBuilder = - process.workingDirectory match { - case Some(directory) => builder.directory(directory.toFile) - case None => builder - } - - def withEnvironmentVariables[O, E]( - process: Process[O, E], - builder: ProcessBuilder - ): ProcessBuilder = { - process.environmentVariables.foreach { case (name, value) => - builder.environment().put(name, value) - } - process.removedEnvironmentVariables.foreach { name => - builder.environment().remove(name) - } - builder - } - - def ouptutRedirectionToNative( - outputRedirection: OutputRedirection - ): ProcessBuilder.Redirect = { - outputRedirection match { - case StdOut() => ProcessBuilder.Redirect.INHERIT - case OutputFile(path, false) => ProcessBuilder.Redirect.to(path.toFile) - case OutputFile(path, true) => - ProcessBuilder.Redirect.appendTo(path.toFile) - case OutputStreamThroughPipe(_, _, _) => ProcessBuilder.Redirect.PIPE - case OutputStreamToSink(_, _) => ProcessBuilder.Redirect.PIPE - } - } - - def inputRedirectionToNative( - inputRedirection: InputRedirection - ): ProcessBuilder.Redirect = { - inputRedirection match { - case StdIn() => ProcessBuilder.Redirect.INHERIT - case InputFile(path) => ProcessBuilder.Redirect.from(path.toFile) - case InputStream(_, _) => ProcessBuilder.Redirect.PIPE - } - } - } - - class JVMProcessRunner() extends JVMProcessRunnerBase[JVMProcessInfo] { - - override protected def getProcessInfo( - process: JvmProcess - ): ProxIO[JVMProcessInfo] = - effect(new JVMProcessInfo(), UnknownProxError.apply) - } - -} diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/runtime.scala b/prox-core/src/main/scala/io/github/vigoo/prox/runtime.scala deleted file mode 100644 index ff63313f..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/runtime.scala +++ /dev/null @@ -1,119 +0,0 @@ -package io.github.vigoo.prox - -private[prox] sealed trait IOResult -private[prox] case object Completed extends IOResult -private[prox] final case class Failed(errors: List[ProxError]) extends IOResult -private[prox] case object Canceled extends IOResult - -trait ProxRuntime { - // NOTE: the Prox prefix was added to avoid collision with the host environment's names (when importing cats.effect._ or zio._) - type ProxExitCode - type ProxFiber[_] - type ProxIO[_] - type ProxResource[_] - - type ProxSink[_] - type ProxPipe[_, _] - type ProxStream[_] - - type ProxMonoid[_] - - protected def exitCodeFromInt(value: Int): ProxExitCode - - protected def unit: ProxIO[Unit] - protected def pure[A](value: A): ProxIO[A] - protected def effect[A](f: => A, wrapError: Throwable => ProxError): ProxIO[A] - protected def blockingEffect[A]( - f: => A, - wrapError: Throwable => ProxError - ): ProxIO[A] - protected def raiseError(error: ProxError): ProxIO[Unit] - protected def ioMap[A, B](io: ProxIO[A], f: A => B): ProxIO[B] - protected def ioFlatMap[A, B](io: ProxIO[A], f: A => ProxIO[B]): ProxIO[B] - protected def traverse[A, B](list: List[A])( - f: A => ProxIO[B] - ): ProxIO[List[B]] - - protected def identityPipe[A]: ProxPipe[A, A] - - protected def bracket[A, B](acquire: ProxIO[A])(use: A => ProxIO[B])( - fin: (A, IOResult) => ProxIO[Unit] - ): ProxIO[B] - - protected def makeResource[A]( - acquire: ProxIO[A], - release: A => ProxIO[Unit] - ): ProxResource[A] - protected def useResource[A, B]( - r: ProxResource[A], - f: A => ProxIO[B] - ): ProxIO[B] - - protected def joinFiber[A](f: ProxFiber[A]): ProxIO[A] - protected def cancelFiber[A](f: ProxFiber[A]): ProxIO[Unit] - - protected def drainStream[A](s: ProxStream[A]): ProxIO[Unit] - protected def streamToVector[A](s: ProxStream[A]): ProxIO[Vector[A]] - protected def foldStream[A, B]( - s: ProxStream[A], - init: B, - f: (B, A) => B - ): ProxIO[B] - protected def foldMonoidStream[A: ProxMonoid](s: ProxStream[A]): ProxIO[A] - protected def streamThrough[A, B]( - s: ProxStream[A], - pipe: ProxPipe[A, B] - ): ProxStream[B] - protected def runStreamTo[A]( - s: ProxStream[A], - sink: ProxSink[A] - ): ProxIO[Unit] - - protected def fromJavaInputStream( - input: java.io.InputStream, - chunkSize: Int - ): ProxStream[Byte] - protected def drainToJavaOutputStream( - stream: ProxStream[Byte], - output: java.io.OutputStream, - flushChunks: Boolean - ): ProxIO[Unit] - - protected def startFiber[A](f: ProxIO[A]): ProxIO[ProxFiber[A]] - - protected implicit class IOOps[A](io: ProxIO[A]) { - def map[B](f: A => B): ProxIO[B] = ioMap(io, f) - def flatMap[B](f: A => ProxIO[B]): ProxIO[B] = ioFlatMap(io, f) - } - - protected implicit class ResourceOps[A](r: ProxResource[A]) { - def use[B](f: A => ProxIO[B]): ProxIO[B] = useResource(r, f) - } - - protected implicit class FiberOps[A](f: ProxFiber[A]) { - def cancel: ProxIO[Unit] = cancelFiber(f) - def join: ProxIO[A] = joinFiber(f) - } - - protected implicit class StreamOps[A](s: ProxStream[A]) { - def drain: ProxIO[Unit] = drainStream(s) - def toVector: ProxIO[Vector[A]] = streamToVector(s) - def fold[B](init: B, f: (B, A) => B): ProxIO[B] = foldStream(s, init, f) - def through[B](pipe: ProxPipe[A, B]): ProxStream[B] = streamThrough(s, pipe) - def run(sink: ProxSink[A]): ProxIO[Unit] = runStreamTo(s, sink) - } - - protected implicit class MonoidStreamOps[A: ProxMonoid](s: ProxStream[A]) { - def foldMonoid: ProxIO[A] = foldMonoidStream(s) - } - - protected implicit class ListProxErrorOps(list: List[ProxError]) { - def toSingleError: ProxError = - list match { - case Nil => - UnknownProxError(new IllegalArgumentException("Error list is empty")) - case List(single) => single - case _ => MultipleProxErrors(list) - } - } -} diff --git a/prox-core/src/main/scala/io/github/vigoo/prox/syntax.scala b/prox-core/src/main/scala/io/github/vigoo/prox/syntax.scala deleted file mode 100644 index c43f6dd7..00000000 --- a/prox-core/src/main/scala/io/github/vigoo/prox/syntax.scala +++ /dev/null @@ -1,126 +0,0 @@ -package io.github.vigoo.prox - -trait SyntaxModule { - this: Prox => - - /** Extension methods for unbound processes enabling the creation of process - * groups - */ - implicit class ProcessPiping(process: Process.UnboundProcess) { - - /** Attaches the output of this process to an other process' input - * - * Use the [[|]] or the [[via]] methods instead for more readability. - * - * @param other - * The other process - * @param channel - * Pipe between the two processes - * @return - * Returns a [[ProcessGroup]] - */ - def pipeInto( - other: Process.UnboundProcess, - channel: ProxPipe[Byte, Byte] - ): ProcessGroup.ProcessGroupImpl = { - - val p1 = process.connectOutput( - OutputStreamThroughPipe( - channel, - (stream: ProxStream[Byte]) => pure(stream) - ) - ) - - ProcessGroup.ProcessGroupImpl( - p1, - List.empty, - other, - List(other, process) - ) - } - - /** Attaches the output of this process to an other process' input - * - * @param other - * The other process - * @return - * Returns a [[ProcessGroup]] - */ - def |(other: Process.UnboundProcess): ProcessGroup.ProcessGroupImpl = - pipeInto(other, identityPipe) - - /** Attaches the output of this process to an other process' input with a - * custom channel - * - * There is a syntax helper step to allow the following syntax: - * {{{ - * val processGroup = process1.via(channel).to(process2) - * }}} - * - * @param channel - * Pipe between the two processes - * @return - * Returns a syntax helper trait that has a [[PipeBuilderSyntax.to]] - * method to finish the construction - */ - def via( - channel: ProxPipe[Byte, Byte] - ): PipeBuilderSyntax[ProcessGroup.ProcessGroupImpl] = - new PipeBuilderSyntax( - new PipeBuilder[ProcessGroup.ProcessGroupImpl] { - override def build( - other: Process.UnboundProcess, - channel: ProxPipe[Byte, Byte] - ): ProcessGroup.ProcessGroupImpl = - process.pipeInto(other, channel) - }, - channel - ) - } - - trait PipeBuilder[P] { - def build(other: Process.UnboundProcess, channel: ProxPipe[Byte, Byte]): P - } - - class PipeBuilderSyntax[P]( - builder: PipeBuilder[P], - channel: ProxPipe[Byte, Byte] - ) { - def to(other: Process.UnboundProcess): P = - builder.build(other, channel) - - } - - /** String interpolator for an alternative of [[Process.apply]] - * - * {{{ - * val process = proc"ls -hal $dir" - * }}} - */ - implicit class ProcessStringContextIO(ctx: StringContext) { - - def proc(args: Any*): Process.ProcessImpl = { - val staticParts = ctx.parts.map(Left.apply) - val injectedParts = args.map(Right.apply) - val parts = - staticParts.zipAll(injectedParts, Left(""), Right("")).flatMap { - case (a, b) => List(a, b) - } - val words = parts - .flatMap { - case Left(value) => value.trim.split(' ') - case Right(value) => List(value.toString) - } - .filter(_.nonEmpty) - .toList - words match { - case head :: remaining => - Process(head, remaining) - case Nil => - throw new IllegalArgumentException( - s"The proc interpolator needs at least a process name" - ) - } - } - } -} diff --git a/prox-fs2-3/src/main/scala/io/github/vigoo/prox/ProxFS2.scala b/prox-fs2-3/src/main/scala/io/github/vigoo/prox/ProxFS2.scala deleted file mode 100644 index 9bf85570..00000000 --- a/prox-fs2-3/src/main/scala/io/github/vigoo/prox/ProxFS2.scala +++ /dev/null @@ -1,198 +0,0 @@ -package io.github.vigoo.prox - -import java.io - -import cats.effect.{Concurrent, Outcome, Async, Sync} -import cats.{Applicative, ApplicativeError, FlatMap, Traverse} - -trait ProxFS2[F[_]] extends Prox { - - val instances: Sync[F] & Concurrent[F] - - override type ProxExitCode = cats.effect.ExitCode - override type ProxFiber[A] = cats.effect.Fiber[F, Throwable, A] - override type ProxIO[A] = F[A] - override type ProxResource[A] = cats.effect.Resource[F, A] - - override type ProxPipe[A, B] = fs2.Pipe[F, A, B] - override type ProxSink[A] = fs2.Pipe[F, A, Unit] - override type ProxStream[A] = fs2.Stream[F, A] - - override type ProxMonoid[A] = cats.kernel.Monoid[A] - - protected override final def exitCodeFromInt(value: Int): ProxExitCode = - cats.effect.ExitCode(value) - - protected override final def unit: ProxIO[Unit] = - Applicative[F](instances).unit - - protected override final def pure[A](value: A): ProxIO[A] = - Applicative[F](instances).pure(value) - - protected override final def effect[A]( - f: => A, - wrapError: Throwable => ProxError - ): ProxIO[A] = { - implicit val i: Sync[F] & Concurrent[F] = instances - Sync[F].adaptError(Sync[F].delay(f)) { case failure: Throwable => - wrapError(failure).toThrowable - } - } - - protected override final def blockingEffect[A]( - f: => A, - wrapError: Throwable => ProxError - ): ProxIO[A] = { - implicit val i: Sync[F] & Concurrent[F] = instances - Sync[F].adaptError(Sync[F].interruptibleMany(f)) { - case failure: Throwable => wrapError(failure).toThrowable - } - } - - protected override final def raiseError(error: ProxError): ProxIO[Unit] = - ApplicativeError[F, Throwable](instances).raiseError(error.toThrowable) - - protected override final def ioMap[A, B]( - io: ProxIO[A], - f: A => B - ): ProxIO[B] = Applicative[F](instances).map(io)(f) - - protected override final def ioFlatMap[A, B]( - io: ProxIO[A], - f: A => ProxIO[B] - ): ProxIO[B] = FlatMap[F](instances).flatMap(io)(f) - - protected override final def traverse[A, B](list: List[A])( - f: A => ProxIO[B] - ): ProxIO[List[B]] = Traverse[List].traverse(list)(f)(instances) - - protected override final def identityPipe[A]: ProxPipe[A, A] = - identity[ProxStream[A]] - - protected override final def bracket[A, B]( - acquire: ProxIO[A] - )(use: A => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B] = - Sync[F](instances).bracketCase(acquire)(use) { - case (value, Outcome.Succeeded(_)) => fin(value, Completed) - case (value, Outcome.Errored(error)) => - fin(value, Failed(List(UnknownProxError(error)))) - case (value, Outcome.Canceled()) => fin(value, Canceled) - } - - protected override final def makeResource[A]( - acquire: ProxIO[A], - release: A => ProxIO[Unit] - ): ProxResource[A] = cats.effect.Resource.make(acquire)(release)(instances) - - protected override final def useResource[A, B]( - r: ProxResource[A], - f: A => ProxIO[B] - ): ProxIO[B] = r.use(f)(instances) - - protected override final def joinFiber[A](f: ProxFiber[A]): ProxIO[A] = - f.joinWithNever(instances) - - protected override final def cancelFiber[A](f: ProxFiber[A]): ProxIO[Unit] = - f.cancel - - protected override final def startFiber[A]( - f: ProxIO[A] - ): ProxIO[ProxFiber[A]] = { - implicit val i: Sync[F] & Concurrent[F] = instances - Concurrent[F].start(f) - } - - protected override final def drainStream[A]( - s: ProxStream[A] - ): ProxIO[Unit] = { - implicit val i: Sync[F] & Concurrent[F] = instances - s.compile.drain - } - - protected override final def streamToVector[A]( - s: ProxStream[A] - ): ProxIO[Vector[A]] = { - implicit val i: Sync[F] & Concurrent[F] = instances - s.compile.toVector - } - - protected override final def foldStream[A, B]( - s: ProxStream[A], - init: B, - f: (B, A) => B - ): ProxIO[B] = { - implicit val i: Sync[F] & Concurrent[F] = instances - s.compile.fold(init)(f) - } - - protected override final def foldMonoidStream[A: ProxMonoid]( - s: ProxStream[A] - ): ProxIO[A] = { - implicit val i: Sync[F] & Concurrent[F] = instances - s.compile.foldMonoid - } - - protected override final def streamThrough[A, B]( - s: ProxStream[A], - pipe: ProxPipe[A, B] - ): ProxStream[B] = s.through(pipe) - - protected override final def runStreamTo[A]( - s: ProxStream[A], - sink: ProxSink[A] - ): ProxIO[Unit] = { - implicit val i: Sync[F] & Concurrent[F] = instances - s.through(sink).compile.drain - } - - protected override final def fromJavaInputStream( - input: io.InputStream, - chunkSize: Int - ): ProxStream[Byte] = - fs2.io.readInputStream(pure(input), chunkSize, closeAfterUse = true)( - instances - ) - - protected override final def drainToJavaOutputStream( - stream: ProxStream[Byte], - output: io.OutputStream, - flushChunks: Boolean - ): ProxIO[Unit] = { - implicit val i: Sync[F] & Concurrent[F] = instances - stream - .through( - if (flushChunks) writeAndFlushOutputStream(output)(_).drain - else - fs2.io.writeOutputStream( - effect(output, UnknownProxError.apply), - closeAfterUse = true - ) - ) - .compile - .drain - } - - private def writeAndFlushOutputStream( - stream: java.io.OutputStream - ): ProxPipe[Byte, Unit] = { - implicit val i: Sync[F] & Concurrent[F] = instances - s => { - fs2.Stream - .bracket(Applicative[F].pure(stream))(os => Sync[F].delay(os.close())) - .flatMap { os => - s.chunks.evalMap { chunk => - Sync[F].blocking { - os.write(chunk.toArray) - os.flush() - } - } - } - } - } -} - -object ProxFS2 { - def apply[F[_]](implicit a: Async[F]): ProxFS2[F] = new ProxFS2[F] { - override val instances: Sync[F] & Concurrent[F] = a - } -} diff --git a/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/InterpolatorSpecs.scala b/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/InterpolatorSpecs.scala deleted file mode 100644 index 7cf039d9..00000000 --- a/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/InterpolatorSpecs.scala +++ /dev/null @@ -1,108 +0,0 @@ -package io.github.vigoo.prox.tests.fs2 - -import zio.test.* -import zio.{Scope, ZIO} - -object InterpolatorSpecs extends ZIOSpecDefault with ProxSpecHelpers { - override val spec: Spec[TestEnvironment & Scope, Any] = - suite("Process interpolators")( - suite("cats-effect process interpolator")( - proxTest("works with single-word process names") { prox => - import prox.* - - val process = proc"ls" - - ZIO.succeed( - assertTrue( - process.command == "ls", - process.arguments.isEmpty - ) - ) - }, - proxTest("works with interpolated process name") { prox => - import prox.* - - val cmd = "ls" - val process = proc"$cmd" - - ZIO.succeed( - assertTrue( - process.command == "ls", - process.arguments.isEmpty - ) - ) - }, - proxTest("works with static parameters") { prox => - import prox.* - - val process = proc"ls -hal tmp" - - ZIO.succeed( - assertTrue( - process.command == "ls", - process.arguments == List("-hal", "tmp") - ) - ) - }, - proxTest("works with static parameters and interpolated process name") { - prox => - import prox.* - - val cmd = "ls" - val process = proc"$cmd -hal tmp" - - ZIO.succeed( - assertTrue( - process.command == "ls", - process.arguments == List("-hal", "tmp") - ) - ) - }, - proxTest("works with static process name and interpolated parameters") { - prox => - import prox.* - - val p1 = "-hal" - val p2 = "tmp" - val process = proc"ls $p1 $p2" - - ZIO.succeed( - assertTrue( - process.command == "ls", - process.arguments == List("-hal", "tmp") - ) - ) - }, - proxTest("works with interpolated name and parameters") { prox => - import prox.* - - val cmd = "ls" - val p1 = "-hal" - val p2 = "tmp" - val process = proc"$cmd $p1 $p2" - - ZIO.succeed( - assertTrue( - process.command == "ls", - process.arguments == List("-hal", "tmp") - ) - ) - }, - proxTest("works with mixed static and interpolated parameters") { - prox => - import prox.* - - val p1 = "hello" - val p2 = "dear visitor" - val process = proc"echo $p1, $p2!!!" - - ZIO.succeed( - assertTrue( - process.command == "echo", - process.arguments == List("hello", ",", "dear visitor", "!!!") - ) - ) - } - ) - ) -} diff --git a/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/ProcessGroupSpecs.scala b/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/ProcessGroupSpecs.scala deleted file mode 100644 index 391952f2..00000000 --- a/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/ProcessGroupSpecs.scala +++ /dev/null @@ -1,757 +0,0 @@ -package io.github.vigoo.prox.tests.fs2 - -import cats.effect.ExitCode -import fs2.io.file.{Files, Flags} -import zio.interop.catz.* -import zio.test.* -import zio.test.Assertion.* -import zio.test.TestAspect.* -import zio.{Scope, Task, ZIO, durationInt} - -object ProcessGroupSpecs extends ZIOSpecDefault with ProxSpecHelpers { - - override val spec: Spec[TestEnvironment & Scope, Any] = - suite("Piping processes together")( - suite("Piping")( - proxTest("is possible with two") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val processGroup = (Process( - "echo", - List("This is a test string") - ) | Process("wc", List("-w"))) ># fs2.text.utf8.decode - val program = processGroup.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - }, - proxTest("is possible with multiple") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val processGroup = ( - Process("echo", List("cat\ncat\ndog\napple")) | - Process("sort") | - Process("uniq", List("-c")) | - Process("head", List("-n 1")) - ) >? fs2.text.utf8.decode.andThen(_.through(fs2.text.lines)) - - val program = processGroup - .run() - .map(r => r.output.map(_.stripLineEnd.trim).filter(_.nonEmpty)) - - program.map(r => assert(r)(hasSameElements(List("1 apple")))) - }, - proxTest("is customizable with pipes") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val customPipe: fs2.Pipe[Task, Byte, Byte] = - (s: fs2.Stream[Task, Byte]) => - s - .through(fs2.text.utf8.decode) - .through(fs2.text.lines) - .map(_.split(' ').toVector) - .map(v => v.map(_ + " !!!").mkString(" ")) - .intersperse("\n") - .through(fs2.text.utf8.encode) - - val processGroup = Process("echo", List("This is a test string")) - .via(customPipe) - .to(Process("wc", List("-w"))) ># fs2.text.utf8.decode - val program = processGroup.run().map(_.output.trim) - - program.map(r => assertTrue(r == "11")) - }, - proxTest("can be mapped") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val processGroup1 = (Process( - "!echo", - List("This is a test string") - ) | Process("!wc", List("-w"))) ># fs2.text.utf8.decode - val processGroup2 = - processGroup1.map(new ProcessGroup.Mapper[String, Unit] { - override def mapFirst[P <: Process[fs2.Stream[Task, Byte], Unit]]( - process: P - ): P = process.withCommand(process.command.tail).asInstanceOf[P] - - override def mapInnerWithIdx[ - P <: Process.UnboundIProcess[fs2.Stream[Task, Byte], Unit] - ](process: P, idx: Int): P = - process.withCommand(process.command.tail).asInstanceOf[P] - - override def mapLast[P <: Process.UnboundIProcess[String, Unit]]( - process: P - ): P = process.withCommand(process.command.tail).asInstanceOf[P] - }) - - val program = processGroup2.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - } - ), - suite("Termination")( - proxTest("can be terminated with cancellation") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val processGroup = - Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) | - Process("sort") - val program = processGroup.start().use { fiber => fiber.cancel } - - program.as(assertCompletes) - } @@ TestAspect.timeout(5.seconds), - proxTest("can be terminated") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) - val p2 = Process("sort") - val processGroup = p1 | p2 - - val program = for { - runningProcesses <- processGroup.startProcessGroup() - _ <- ZIO.sleep(250.millis) - result <- runningProcesses.terminate() - } yield result.exitCodes.toList - - program.map(r => assertTrue(r.contains(p1 -> ExitCode(1)))) - } @@ TestAspect.withLiveClock, - proxTest("can be killed") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process( - "perl", - List("-e", """$SIG{TERM} = 'IGNORE'; sleep 30; exit 2""") - ) - val p2 = Process("sort") - val processGroup = p1 | p2 - - val program = for { - runningProcesses <- processGroup.startProcessGroup() - _ <- ZIO.sleep(250.millis) - result <- runningProcesses.kill() - } yield result.exitCodes - - // Note: we can't assert on the second process' exit code because there is a race condition - // between killing it directly and being stopped because of the upstream process got killed. - program.map(r => assert(r)(contains(p1 -> ExitCode(137)))) - } @@ TestAspect.withLiveClock - ), - suite("Input redirection")( - proxTest("can be fed with an input stream") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val stream = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val processGroup = (Process("cat") | Process( - "wc", - List("-w") - )) < stream ># fs2.text.utf8.decode - val program = processGroup.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - }, - proxTest("can be fed with an input file") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - withTempFile { tempFile => - val program = for { - _ <- ZIO.attempt( - java.nio.file.Files.write( - tempFile.toPath, - "This is a test string".getBytes("UTF-8") - ) - ) - processGroup = (Process("cat") | Process( - "wc", - List("-w") - )) < tempFile.toPath ># fs2.text.utf8.decode - result <- processGroup.run() - } yield result.output.trim - - program.map(r => assertTrue(r == "5")) - } - } - ), - suite("Output redirection")( - proxTest("output can be redirected to file") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - withTempFile { tempFile => - val processGroup = (Process( - "echo", - List("This is a test string") - ) | Process("wc", List("-w"))) > tempFile.toPath - val program = for { - _ <- processGroup.run() - contents <- Files - .forAsync[Task] - .readAll( - fs2.io.file.Path.fromNioPath(tempFile.toPath), - 1024, - Flags.Read - ) - .through(fs2.text.utf8.decode) - .compile - .foldMonoid - } yield contents.trim - - program.map(r => assertTrue(r == "5")) - } - } - ), - suite("Error redirection")( - proxTest("can redirect each error output to a stream") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2) !># fs2.text.utf8.decode - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo("world"))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - proxTest("can redirect each error output to a sink") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val builder = new StringBuilder - val target: fs2.Pipe[Task, Byte, Unit] = _.evalMap(byte => - ZIO.attempt { - builder.append(byte.toChar) - }.unit - ) - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2) !> target - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo(()))) && - assert(result.errors.get(p2))(isSome(equalTo(()))) && - assert(result.output)(equalTo(())) && - assert(builder.toString.toSeq.sorted)( - equalTo("Helloworld".toSeq.sorted) - ) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - proxTest("can redirect each error output to a vector") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world!"""")) - - val stream = fs2.text.utf8 - .decode[Task] - .andThen(fs2.text.lines) - .andThen(_.map(s => s.length)) - - val processGroup = (p1 | p2) !>? stream - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(hasSameElements(List(5)))) && - assert(result.errors.get(p2))(isSome(hasSameElements(List(6)))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - proxTest("can drain each error output") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2) drainErrors fs2.text.utf8.decode - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo(()))) && - assert(result.errors.get(p2))(isSome(equalTo(()))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - proxTest("can fold each error output") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process("perl", List("-e", "print STDERR 'Hello\nworld'")) - val p2 = Process("perl", List("-e", "print STDERR 'Does\nit\nwork?'")) - val processGroup = (p1 | p2).foldErrors( - fs2.text.utf8.decode.andThen(fs2.text.lines), - Vector.empty, - (l: Vector[Option[Char]], s: String) => l :+ s.headOption - ) - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))( - isSome(equalTo(Vector(Some('H'), Some('w')))) - ) && - assert(result.errors.get(p2))( - isSome(equalTo(Vector(Some('D'), Some('i'), Some('w')))) - ) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - } - ), - suite("Error redirection customized per process")( - proxTest( - "can redirect each error output to a stream customized per process" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2).customizedPerProcess.errorsToFoldMonoid { - case p if p == p1 => - fs2.text.utf8.decode.andThen(_.map(s => "P1: " + s)) - case p if p == p2 => - fs2.text.utf8.decode.andThen(_.map(s => "P2: " + s)) - } - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo("P1: Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo("P2: world"))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - proxTest( - "can redirect each error output to a sink customized per process" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val builder1 = new StringBuilder - val builder2 = new StringBuilder - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2).customizedPerProcess.errorsToSink { - case p if p == p1 => - _.evalMap(byte => - ZIO.attempt { - builder1.append(byte.toChar) - }.unit - ) - case p if p == p2 => - _.evalMap(byte => - ZIO.attempt { - builder2.append(byte.toChar) - }.unit - ) - } - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo(()))) && - assert(result.errors.get(p2))(isSome(equalTo(()))) && - assert(result.output)(equalTo(())) && - assert(builder1.toString)(equalTo("Hello")) && - assert(builder2.toString)(equalTo("world")) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - proxTest( - "can redirect each error output to a vector customized per process" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world!"""")) - - val stream = fs2.text.utf8 - .decode[Task] - .andThen(fs2.text.lines) - .andThen(_.map(s => s.length)) - - val processGroup = (p1 | p2).customizedPerProcess.errorsToVector { - case p if p == p1 => stream.andThen(_.map(l => (1, l))) - case p if p == p2 => stream.andThen(_.map(l => (2, l))) - } - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))( - isSome(hasSameElements(List((1, 5)))) - ) && - assert(result.errors.get(p2))( - isSome(hasSameElements(List((2, 6)))) - ) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - proxTest("can drain each error output customized per process") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2).customizedPerProcess.drainErrors(_ => - fs2.text.utf8.decode - ) - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo(()))) && - assert(result.errors.get(p2))(isSome(equalTo(()))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - proxTest("can fold each error output customized per process") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process("perl", List("-e", "print STDERR 'Hello\nworld'")) - val p2 = Process("perl", List("-e", "print STDERR 'Does\nit\nwork?'")) - val processGroup = (p1 | p2).customizedPerProcess.foldErrors( - { - case p if p == p1 => - fs2.text.utf8 - .decode[Task] - .andThen(fs2.text.lines) - case p if p == p2 => - fs2.text.utf8 - .decode[Task] - .andThen(fs2.text.lines) - .andThen(_.map(_.reverse)) - }, - Vector.empty, - (l: Vector[Option[Char]], s: String) => l :+ s.headOption - ) - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))( - isSome(equalTo(Vector(Some('H'), Some('w')))) - ) && - assert(result.errors.get(p2))( - isSome(equalTo(Vector(Some('s'), Some('t'), Some('?')))) - ) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - proxTest("can redirect each error output to file") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - withTempFile { tempFile1 => - withTempFile { tempFile2 => - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2).customizedPerProcess.errorsToFile { - case p if p == p1 => tempFile1.toPath - case p if p == p2 => tempFile2.toPath - } - val program = for { - _ <- processGroup.run() - contents1 <- Files - .forAsync[Task] - .readAll( - fs2.io.file.Path.fromNioPath(tempFile1.toPath), - 1024, - Flags.Read - ) - .through(fs2.text.utf8.decode) - .compile - .foldMonoid - contents2 <- Files - .forAsync[Task] - .readAll( - fs2.io.file.Path.fromNioPath(tempFile2.toPath), - 1024, - Flags.Read - ) - .through(fs2.text.utf8.decode) - .compile - .foldMonoid - } yield (contents1, contents2) - - program.map(r => assertTrue(r == ("Hello", "world"))) - } - } - } - ), - suite("Redirection ordering")( - proxTest( - "can redirect each error output to a stream if fed with an input stream and redirected to an output stream" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val stream = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - (p1 | p2 | p3) < stream ># fs2.text.utf8.decode !># fs2.text.utf8.decode - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - proxTest( - "can redirect output if each error output and input are already redirected" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val stream = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - ((p1 | p2 | p3) < stream !># fs2.text.utf8.decode) ># fs2.text.utf8.decode - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - proxTest( - "can attach output and then input stream if each error output and standard output are already redirected" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val stream = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - ((p1 | p2 | p3) !># fs2.text.utf8.decode) ># fs2.text.utf8.decode < stream - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - proxTest( - "can attach input and then output stream if each error output and standard output are already redirected" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val stream = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - ((p1 | p2 | p3) !># fs2.text.utf8.decode) < stream ># fs2.text.utf8.decode - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - proxTest( - "can attach input stream and errors if standard output is already redirected" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val stream = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - ((p1 | p2 | p3) ># fs2.text.utf8.decode) < stream !># fs2.text.utf8.decode - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - proxTest( - "can attach errors and finally input stream if standard output is already redirected" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val stream = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - (((p1 | p2 | p3) ># fs2.text.utf8.decode) !># fs2.text.utf8.decode) < stream - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - } - ), - test("bound process is not pipeable") { - typeCheck( - """val bad = (Process("echo", List("Hello world")) ># fs2.text.utf8.decode) | Process("wc", List("-w"))""" - ).map(r => - assert(r)( - isLeft(anything) - ) - ) - } - ) @@ timeout(60.seconds) @@ sequential -} diff --git a/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/ProcessSpecs.scala b/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/ProcessSpecs.scala deleted file mode 100644 index 65d91e27..00000000 --- a/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/ProcessSpecs.scala +++ /dev/null @@ -1,808 +0,0 @@ -package io.github.vigoo.prox.tests.fs2 - -import cats.effect.ExitCode -import fs2.io.file.{Files, Flags} -import zio.interop.catz.* -import zio.test.Assertion.{anything, equalTo, hasSameElements, isLeft} -import zio.test.TestAspect.* -import zio.test.* -import zio.{Scope, Task, ZIO, durationInt} - -object ProcessSpecs extends ZIOSpecDefault with ProxSpecHelpers { - override val spec: Spec[TestEnvironment & Scope, Any] = - suite("Executing a process")( - proxTest("returns the exit code") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val program = for { - trueResult <- Process("true").run() - falseResult <- Process("false").run() - } yield (trueResult.exitCode, falseResult.exitCode) - - program.map(r => assertTrue(r == (ExitCode(0), ExitCode(1)))) - }, - suite("Output redirection")( - proxTest("can redirect output to a file") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - withTempFile { tempFile => - val process = - Process("echo", List("Hello world!")) > tempFile.toPath - val program = for { - _ <- process.run() - contents <- Files - .forAsync[Task] - .readAll( - fs2.io.file.Path.fromNioPath(tempFile.toPath), - 1024, - Flags.Read - ) - .through(fs2.text.utf8.decode) - .compile - .foldMonoid - } yield contents - - program.map(r => assertTrue(r == "Hello world!\n")) - } - }, - proxTest("can redirect output to append a file") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - withTempFile { tempFile => - val process1 = Process("echo", List("Hello")) > tempFile.toPath - val process2 = Process("echo", List("world")) >> tempFile.toPath - val program = for { - _ <- process1.run() - _ <- process2.run() - contents <- Files - .forAsync[Task] - .readAll( - fs2.io.file.Path.fromNioPath(tempFile.toPath), - 1024, - Flags.Read - ) - .through(fs2.text.utf8.decode) - .compile - .foldMonoid - } yield contents - - program.map(r => assertTrue(r == "Hello\nworld\n")) - } - }, - proxTest("can redirect output to stream") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = - Process("echo", List("Hello world!")) ># fs2.text.utf8.decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world!\n")) - }, - proxTest("can redirect output to stream folding monoid") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process( - "echo", - List("Hello\nworld!") - ) ># fs2.text.utf8.decode.andThen(fs2.text.lines) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Helloworld!")) - }, - proxTest("can redirect output to stream collected to vector") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - case class StringLength(value: Int) - - val stream = fs2.text.utf8 - .decode[Task] - .andThen(fs2.text.lines) - .andThen(_.map(s => StringLength(s.length))) - val process = Process("echo", List("Hello\nworld!")) >? stream - val program = process.run().map(_.output) - - program.map(r => - assert(r)( - hasSameElements( - List(StringLength(5), StringLength(6), StringLength(0)) - ) - ) - ) - }, - proxTest("can redirect output to stream and ignore it's result") { - prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process("echo", List("Hello\nworld!")).drainOutput( - fs2.text.utf8.decode.andThen(fs2.text.lines) - ) - val program = process.run().map(_.output) - - program.as(assertCompletes) - }, - proxTest("can redirect output to stream and fold it") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process("echo", List("Hello\nworld!")).foldOutput( - fs2.text.utf8.decode.andThen(fs2.text.lines), - Vector.empty, - (l: Vector[Option[Char]], s: String) => l :+ s.headOption - ) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == Vector(Some('H'), Some('w'), None))) - }, - proxTest("can redirect output to a sink") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val builder = new StringBuilder - val target: fs2.Pipe[Task, Byte, Unit] = _.evalMap(byte => - ZIO.attempt { - builder.append(byte.toChar) - }.unit - ) - - val process = Process("echo", List("Hello world!")) > target - val program = process.run().as(builder.toString) - - program.map(r => assertTrue(r == "Hello world!\n")) - } - ), - suite("Error redirection")( - proxTest("can redirect error to a file") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - withTempFile { tempFile => - val process = Process( - "perl", - List("-e", "print STDERR 'Hello world!'") - ) !> tempFile.toPath - val program = for { - _ <- process.run() - contents <- Files - .forAsync[Task] - .readAll( - fs2.io.file.Path.fromNioPath(tempFile.toPath), - 1024, - Flags.Read - ) - .through(fs2.text.utf8.decode) - .compile - .foldMonoid - } yield contents - - program.map(r => assertTrue(r == "Hello world!")) - } - }, - proxTest("can redirect error to append a file") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - withTempFile { tempFile => - val process1 = Process( - "perl", - List("-e", "print STDERR Hello") - ) !> tempFile.toPath - val process2 = Process( - "perl", - List("-e", "print STDERR world") - ) !>> tempFile.toPath - val program = for { - _ <- process1.run() - _ <- process2.run() - contents <- Files - .forAsync[Task] - .readAll( - fs2.io.file.Path.fromNioPath(tempFile.toPath), - 1024, - Flags.Read - ) - .through(fs2.text.utf8.decode) - .compile - .foldMonoid - } yield contents - - program.map(r => assertTrue(r == "Helloworld")) - } - }, - proxTest("can redirect error to stream") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process( - "perl", - List("-e", """print STDERR "Hello"""") - ) !># fs2.text.utf8.decode - val program = process.run().map(_.error) - - program.map(r => assertTrue(r == "Hello")) - }, - proxTest("can redirect error to stream folding monoid") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process( - "perl", - List("-e", "print STDERR 'Hello\nworld!'") - ) !># fs2.text.utf8.decode.andThen(fs2.text.lines) - val program = process.run().map(_.error) - - program.map(r => assertTrue(r == "Helloworld!")) - }, - proxTest("can redirect error to stream collected to vector") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - case class StringLength(value: Int) - - val stream = fs2.text.utf8 - .decode[Task] - .andThen(fs2.text.lines) - .andThen(_.map(s => StringLength(s.length))) - val process = Process( - "perl", - List("-e", "print STDERR 'Hello\nworld!'") - ) !>? stream - val program = process.run().map(_.error) - - program.map(r => - assert(r)(hasSameElements(List(StringLength(5), StringLength(6)))) - ) - }, - proxTest("can redirect error to stream and ignore it's result") { - prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = - Process("perl", List("-e", "print STDERR 'Hello\nworld!'")) - .drainError(fs2.text.utf8.decode.andThen(fs2.text.lines)) - val program = process.run().map(_.error) - - program.as(assertCompletes) - }, - proxTest("can redirect error to stream and fold it") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process( - "perl", - List("-e", "print STDERR 'Hello\nworld!'") - ).foldError( - fs2.text.utf8.decode.andThen(fs2.text.lines), - Vector.empty, - (l: Vector[Option[Char]], s: String) => l :+ s.headOption - ) - val program = process.run().map(_.error) - - program.map(r => assertTrue(r == Vector(Some('H'), Some('w')))) - }, - proxTest("can redirect error to a sink") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val builder = new StringBuilder - val target: fs2.Pipe[Task, Byte, Unit] = _.evalMap(byte => - ZIO.attempt { - builder.append(byte.toChar) - }.unit - ) - - val process = - Process("perl", List("-e", """print STDERR "Hello"""")) !> target - val program = process.run().as(builder.toString) - - program.map(r => assertTrue(r == "Hello")) - } - ), - suite("Redirection ordering")( - proxTest("can redirect first input and then error to stream") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val process = Process( - "perl", - List("-e", """my $str = <>; print STDERR "$str"""".stripMargin) - ) < source !># fs2.text.utf8.decode - val program = process.run().map(_.error) - - program.map(r => assertTrue(r == "This is a test string")) - }, - proxTest("can redirect error first then output to stream") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = (Process( - "perl", - List("-e", """print STDOUT Hello; print STDERR World""".stripMargin) - ) !># fs2.text.utf8.decode) ># fs2.text.utf8.decode - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - }, - proxTest("can redirect output first then error to stream") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = (Process( - "perl", - List("-e", """print STDOUT Hello; print STDERR World""".stripMargin) - ) ># fs2.text.utf8.decode) !># fs2.text.utf8.decode - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - }, - proxTest( - "can redirect output first then error finally input to stream" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = fs2.Stream("Hello").through(fs2.text.utf8.encode) - val process = ((Process( - "perl", - List( - "-e", - """my $str = <>; print STDOUT "$str"; print STDERR World""".stripMargin - ) - ) - ># fs2.text.utf8.decode) - !># fs2.text.utf8.decode) < source - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - }, - proxTest( - "can redirect output first then input finally error to stream" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = fs2.Stream("Hello").through(fs2.text.utf8.encode) - val process = ((Process( - "perl", - List( - "-e", - """my $str = <>; print STDOUT "$str"; print STDERR World""".stripMargin - ) - ) - ># fs2.text.utf8.decode) - < source) !># fs2.text.utf8.decode - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - }, - proxTest( - "can redirect input first then error finally output to stream" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = fs2.Stream("Hello").through(fs2.text.utf8.encode) - val process = ((Process( - "perl", - List( - "-e", - """my $str = <>; print STDOUT "$str"; print STDERR World""".stripMargin - ) - ) - < source) - !># fs2.text.utf8.decode) ># fs2.text.utf8.decode - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - } - ), - suite("Input redirection")( - proxTest("can use stream as input") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val process = - Process("wc", List("-w")) < source ># fs2.text.utf8.decode - val program = process.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - }, - proxTest("can use stream as input flushing after each chunk") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = fs2 - .Stream("This ", "is a test", " string") - .through(fs2.text.utf8.encode) - val process = - (Process("wc", List("-w")) !< source) ># fs2.text.utf8.decode - val program = process.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - } - ), - suite("Termination")( - proxTest("can be terminated with cancellation") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) - val program = process.start().use { fiber => - fiber.cancel.delay(250.millis) - } - - program.as(assertCompletes) - } @@ TestAspect.withLiveClock @@ TestAspect.timeout(5.seconds), - proxTest("can be terminated by releasing the resource") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) - val program = process.start().use { _ => ZIO.sleep(250.millis) } - - program.as(assertCompletes) - } @@ TestAspect.withLiveClock @@ TestAspect.timeout(5.seconds), - proxTest("can be terminated") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) - val program = for { - runningProcess <- process.startProcess() - _ <- ZIO.sleep(250.millis) - result <- runningProcess.terminate() - } yield result.exitCode - - program.map(r => assertTrue(r == ExitCode(1))) - } @@ TestAspect.withLiveClock, - proxTest("can be killed") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process( - "perl", - List("-e", """$SIG{TERM} = 'IGNORE'; sleep 30; exit 2""") - ) - val program = for { - runningProcess <- process.startProcess() - _ <- ZIO.sleep(250.millis) - result <- runningProcess.kill() - } yield result.exitCode - - program.map(r => assertTrue(r == ExitCode(137))) - } @@ TestAspect.withLiveClock, - proxTest("can be checked if is alive") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = Process("sleep", List("10")) - val program = for { - runningProcess <- process.startProcess() - isAliveBefore <- runningProcess.isAlive - _ <- runningProcess.terminate() - isAliveAfter <- runningProcess.isAlive - } yield (isAliveBefore, isAliveAfter) - - program.map(r => assertTrue(r == (true, false))) - } - ), - suite("Customization")( - proxTest("can change the command") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = - Process("something", List("Hello", "world")) ># fs2.text.utf8.decode - val p2 = p1.withCommand("echo") - val program = p2.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world\n")) - }, - proxTest("can change the arguments") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val p1 = Process("echo") ># fs2.text.utf8.decode - val p2 = p1.withArguments(List("Hello", "world")) - val program = p2.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world\n")) - }, - proxTest("respects the working directory") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - ZIO.attempt(java.nio.file.Files.createTempDirectory("prox")).flatMap { - tempDirectory => - val process = - (Process("pwd") in tempDirectory) ># fs2.text.utf8.decode - val program = process.run().map(_.output.trim) - - program.map(r => - assert(r)( - equalTo(tempDirectory.toString) || equalTo( - s"/private${tempDirectory}" - ) - ) - ) - } - }, - proxTest("is customizable with environment variables") { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = - (Process("sh", List("-c", "echo \"Hello $TEST1! I am $TEST2!\"")) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) ># fs2.text.utf8.decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - proxTest("is customizable with excluded environment variables") { - prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = - (Process("sh", List("-c", "echo \"Hello $TEST1! I am $TEST2!\"")) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox") - `without` "TEST1") ># fs2.text.utf8.decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello ! I am prox!\n")) - }, - proxTest("is customizable with environment variables output is bound") { - prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = (Process( - "sh", - List("-c", "echo \"Hello $TEST1! I am $TEST2!\"") - ) ># fs2.text.utf8.decode - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - proxTest( - "is customizable with environment variables if input is bound" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val process = ((Process( - "sh", - List("-c", "cat > /dev/null; echo \"Hello $TEST1! I am $TEST2!\"") - ) < source) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) ># fs2.text.utf8.decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - proxTest( - "is customizable with environment variables if error is bound" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = ((Process( - "sh", - List("-c", "echo \"Hello $TEST1! I am $TEST2!\"") - ) !># fs2.text.utf8.decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) ># fs2.text.utf8.decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - proxTest( - "is customizable with environment variables if input and output are bound" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val process = (((Process( - "sh", - List("-c", "cat > /dev/null; echo \"Hello $TEST1! I am $TEST2!\"") - ) < source) ># fs2.text.utf8.decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - proxTest( - "is customizable with environment variables if input and error are bound" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val process = (((Process( - "sh", - List("-c", "cat > /dev/null; echo \"Hello $TEST1! I am $TEST2!\"") - ) < source) !># fs2.text.utf8.decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) ># fs2.text.utf8.decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - proxTest( - "is customizable with environment variables if output and error are bound" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val process = (((Process( - "sh", - List("-c", "echo \"Hello $TEST1! I am $TEST2!\"") - ) !># fs2.text.utf8.decode) ># fs2.text.utf8.decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - proxTest( - "is customizable with environment variables if everything is bound" - ) { prox => - import prox.* - - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - val source = - fs2.Stream("This is a test string").through(fs2.text.utf8.encode) - val process = ((((Process( - "sh", - List("-c", "cat > /dev/null; echo \"Hello $TEST1! I am $TEST2!\"") - ) < source) !># fs2.text.utf8.decode) ># fs2.text.utf8.decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - } - ), - test("double output redirect is illegal") { - typeCheck( - """val bad = Process("echo", List("Hello world")) > new File("x").toPath > new File("y").toPath""" - ).map(r => - assert(r)( - isLeft(anything) - ) - ) - }, - test("double error redirect is illegal") { - typeCheck( - """val bad = Process("echo", List("Hello world")) !> new File("x").toPath !> new File("y").toPath""" - ).map(r => - assert(r)( - isLeft(anything) - ) - ) - }, - test("double input redirect is illegal") { - typeCheck( - """val bad = (Process("echo", List("Hello world")) < fs2.Stream("X").through(fs2.text.utf8.encode)) < fs2.Stream("Y").through(fs2.text.utf8.encode)""" - ).map(r => - assert(r)( - isLeft(anything) - ) - ) - } - ) @@ timeout(60.seconds) @@ sequential -} diff --git a/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/ProxSpecHelpers.scala b/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/ProxSpecHelpers.scala deleted file mode 100644 index 7ad21974..00000000 --- a/prox-fs2-3/src/test/scala/io/github/vigoo/prox/tests/fs2/ProxSpecHelpers.scala +++ /dev/null @@ -1,29 +0,0 @@ -package io.github.vigoo.prox.tests.fs2 - -import io.github.vigoo.prox.ProxFS2 -import zio.interop.catz.* -import zio.test.* -import zio.{Task, ZIO} - -import java.io.File - -trait ProxSpecHelpers { - - def proxTest(label: String)( - assertion: ProxFS2[Task] => ZIO[Any, Throwable, TestResult] - ): Spec[Any, scala.Throwable] = { - test(label) { - ZIO.runtime[Any].flatMap { implicit env => - assertion(ProxFS2[Task]) - } - } - } - - def withTempFile[A]( - inner: File => ZIO[Any, Throwable, A] - ): ZIO[Any, Throwable, A] = - ZIO.acquireReleaseWith( - ZIO.attempt(File.createTempFile("test", "txt")) - )(file => ZIO.attempt(file.delete()).orDie)(inner) - -} diff --git a/prox-java9/src/main/scala/io/github/vigoo/prox/java9/runner.scala b/prox-java9/src/main/scala/io/github/vigoo/prox/java9/runner.scala deleted file mode 100644 index 7ebfcacf..00000000 --- a/prox-java9/src/main/scala/io/github/vigoo/prox/java9/runner.scala +++ /dev/null @@ -1,21 +0,0 @@ -package io.github.vigoo.prox.java9 - -import java.lang.Process as JvmProcess - -import io.github.vigoo.prox.{FailedToQueryState, Prox} - -trait Java9Module { - this: Prox => - - case class JVM9ProcessInfo(pid: Long) extends JVMProcessInfo - - class JVM9ProcessRunner() extends JVMProcessRunnerBase[JVM9ProcessInfo] { - - override protected def getProcessInfo( - process: JvmProcess - ): ProxIO[JVM9ProcessInfo] = - effect(process.pid(), FailedToQueryState.apply).map(pid => - JVM9ProcessInfo(pid) - ) - } -} diff --git a/prox-zstream-2/src/main/scala/io/github/vigoo/prox/ProxZStream.scala b/prox-zstream-2/src/main/scala/io/github/vigoo/prox/ProxZStream.scala deleted file mode 100644 index 9f9eb162..00000000 --- a/prox-zstream-2/src/main/scala/io/github/vigoo/prox/ProxZStream.scala +++ /dev/null @@ -1,236 +0,0 @@ -package io.github.vigoo.prox - -import java.io -import java.io.IOException - -import zio.prelude.Identity -import zio.stream.{ZSink, ZStream, ZPipeline} -import zio.* - -import scala.language.implicitConversions - -trait ProxZStream extends Prox { - - case class TransformAndSink[A, B]( - transform: ZStream[Any, ProxError, A] => ZStream[Any, ProxError, B], - sink: ZSink[Any, ProxError, B, Any, Unit] - ) { - private[ProxZStream] def run( - s: ZStream[Any, ProxError, A] - ): ZIO[Any, ProxError, Unit] = - transform(s).run(sink) - } - object TransformAndSink { - def apply[A, B]( - transducer: ZPipeline[Any, ProxError, A, B], - sink: ZSink[Any, ProxError, B, Any, Unit] - ): TransformAndSink[A, B] = - TransformAndSink(_.via(transducer), sink) - } - - override type ProxExitCode = zio.ExitCode - override type ProxFiber[A] = zio.Fiber[ProxError, A] - override type ProxIO[A] = ZIO[Any, ProxError, A] - override type ProxResource[A] = ZIO[Scope, ProxError, A] - override type ProxStream[A] = ZStream[Any, ProxError, A] - override type ProxPipe[A, B] = ProxStream[A] => ProxStream[B] - override type ProxSink[A] = TransformAndSink[A, ?] - override type ProxMonoid[A] = zio.prelude.Identity[A] - - protected override final def exitCodeFromInt(value: Int): ProxExitCode = - zio.ExitCode(value) - - protected override final def unit: ProxIO[Unit] = - ZIO.unit - - protected override final def pure[A](value: A): ProxIO[A] = - ZIO.succeed(value) - - protected override final def effect[A]( - f: => A, - wrapError: Throwable => ProxError - ): ProxIO[A] = - ZIO.attempt(f).mapError(wrapError) - - protected override final def blockingEffect[A]( - f: => A, - wrapError: Throwable => ProxError - ): ProxIO[A] = - ZIO.attemptBlockingInterrupt(f).mapError(wrapError).interruptible - - protected override final def raiseError(error: ProxError): ProxIO[Unit] = - ZIO.fail(error) - - protected override final def ioMap[A, B]( - io: ProxIO[A], - f: A => B - ): ProxIO[B] = - io.map(f) - - protected override final def ioFlatMap[A, B]( - io: ProxIO[A], - f: A => ProxIO[B] - ): ProxIO[B] = - io.flatMap(f) - - protected override final def traverse[A, B](list: List[A])( - f: A => ProxIO[B] - ): ProxIO[List[B]] = - ZIO.foreach(list)(f) - - protected override final def identityPipe[A]: ProxPipe[A, A] = - identity - - protected override final def bracket[A, B]( - acquire: ProxIO[A] - )(use: A => ProxIO[B])(fin: (A, IOResult) => ProxIO[Unit]): ProxIO[B] = { - ZIO.acquireReleaseExitWith(acquire) { - (value: A, exit: Exit[ProxError, B]) => - exit match { - case Exit.Success(_) => - fin(value, Completed).mapError(_.toThrowable).orDie - case Exit.Failure(cause) => - if (cause.isInterrupted) { - fin(value, Canceled).mapError(_.toThrowable).orDie - } else { - fin( - value, - Failed( - cause.failures ++ cause.defects.map(UnknownProxError.apply) - ) - ).mapError(_.toThrowable).orDie - } - } - }(a => ZIO.allowInterrupt *> use(a)) - } - - protected override final def makeResource[A]( - acquire: ProxIO[A], - release: A => ProxIO[Unit] - ): ProxResource[A] = - ZIO.acquireRelease(acquire)(x => release(x).mapError(_.toThrowable).orDie) - - protected override final def useResource[A, B]( - r: ProxResource[A], - f: A => ProxIO[B] - ): ProxIO[B] = - ZIO.scoped(r.flatMap(f)) - - protected override final def joinFiber[A](f: ProxFiber[A]): ProxIO[A] = - f.join - - protected override final def cancelFiber[A](f: ProxFiber[A]): ProxIO[Unit] = - f.interrupt.unit - - protected override final def drainStream[A](s: ProxStream[A]): ProxIO[Unit] = - s.runDrain - - protected override final def streamToVector[A]( - s: ProxStream[A] - ): ProxIO[Vector[A]] = - s.runCollect.map(_.toVector) - - protected override final def foldStream[A, B]( - s: ProxStream[A], - init: B, - f: (B, A) => B - ): ProxIO[B] = - s.runFold(init)(f) - - protected override final def foldMonoidStream[A: Identity]( - s: ProxStream[A] - ): ProxIO[A] = - s.runFold(Identity[A].identity)((a, b) => Identity[A].combine(a, b)) - - protected override final def streamThrough[A, B]( - s: ProxStream[A], - pipe: ProxPipe[A, B] - ): ProxStream[B] = - pipe(s) - - override protected final def runStreamTo[A]( - s: ProxStream[A], - sink: ProxSink[A] - ): ProxIO[Unit] = - sink.run(s) - - protected override final def fromJavaInputStream( - input: io.InputStream, - chunkSize: Int - ): ProxStream[Byte] = - ZStream - .fromInputStream(input, chunkSize) - .mapError(FailedToReadProcessOutput.apply) - - protected override final def drainToJavaOutputStream( - stream: ProxStream[Byte], - output: io.OutputStream, - flushChunks: Boolean - ): ProxIO[Unit] = { - val managedOutput = - ZIO.acquireRelease(ZIO.succeed(output))(s => ZIO.attempt(s.close()).orDie) - if (flushChunks) { - stream - .run( - flushingOutputStreamSink(managedOutput) - .mapError(FailedToWriteProcessInput.apply) - ) - .unit - } else { - stream - .run( - ZSink - .fromOutputStreamScoped(managedOutput) - .mapError(FailedToWriteProcessInput.apply) - ) - .unit - } - } - - private final def flushingOutputStreamSink( - managedOutput: ZIO[Scope, Nothing, io.OutputStream] - ): ZSink[Any, IOException, Byte, Byte, Long] = - ZSink.unwrapScoped { - managedOutput.map { os => - ZSink.foldLeftChunksZIO(0L) { (bytesWritten, byteChunk: Chunk[Byte]) => - ZIO - .attemptBlockingInterrupt { - val bytes = byteChunk.toArray - os.write(bytes) - os.flush() - bytesWritten + bytes.length - } - .refineOrDie { case e: IOException => - e - } - } - } - } - - protected override final def startFiber[A]( - f: ProxIO[A] - ): ProxIO[ProxFiber[A]] = - f.fork - - implicit def transducerAsPipe[A, B]( - transducer: ZPipeline[Any, ProxError, A, B] - ): ProxPipe[A, B] = - (s: ProxStream[A]) => s.via(transducer) - - implicit def transducerAsPipeThrowable[A, B]( - transducer: ZPipeline[Any, Throwable, A, B] - ): ProxPipe[A, B] = - (s: ProxStream[A]) => - s.via( - ZPipeline.fromChannel( - transducer.channel.mapError(UnknownProxError.apply) - ) - ) - - implicit def sinkAsTransformAndSink[A]( - sink: ZSink[Any, ProxError, A, Any, Unit] - ): TransformAndSink[A, A] = - TransformAndSink(identity[ZStream[Any, ProxError, A]] _, sink) -} - -object zstream extends ProxZStream diff --git a/prox-zstream-2/src/test/scala/io/github/vigoo/prox/tests/zstream/ProcessGroupSpecs.scala b/prox-zstream-2/src/test/scala/io/github/vigoo/prox/tests/zstream/ProcessGroupSpecs.scala deleted file mode 100644 index 2dc9813b..00000000 --- a/prox-zstream-2/src/test/scala/io/github/vigoo/prox/tests/zstream/ProcessGroupSpecs.scala +++ /dev/null @@ -1,652 +0,0 @@ -package io.github.vigoo.prox.tests.zstream - -import io.github.vigoo.prox.zstream.* -import io.github.vigoo.prox.{UnknownProxError, zstream} -import zio.* -import zio.stream.{ZPipeline, ZSink, ZStream} -import zio.test.* -import zio.test.Assertion.* -import zio.test.TestAspect.* - -import java.nio.charset.StandardCharsets -import java.nio.file.Files - -object ProcessGroupSpecs extends ZIOSpecDefault with ProxSpecHelpers { - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - override val spec: Spec[TestEnvironment & Scope, Any] = - suite("Piping processes together")( - suite("Piping")( - test("is possible with two") { - - val processGroup = (Process( - "echo", - List("This is a test string") - ) | Process("wc", List("-w"))) ># ZPipeline.utf8Decode - val program = processGroup.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - }, - test("is possible with multiple") { - - val processGroup = ( - Process("echo", List("cat\ncat\ndog\napple")) | - Process("sort") | - Process("uniq", List("-c")) | - Process("head", List("-n 1")) - ) >? (ZPipeline.utf8Decode >>> ZPipeline.splitLines) - - val program = processGroup - .run() - .map(r => r.output.map(_.stripLineEnd.trim).filter(_.nonEmpty)) - - program.map(r => assert(r)(hasSameElements(List("1 apple")))) - }, - test("is customizable with pipes") { - val customPipe = (s: zstream.ProxStream[Byte]) => - s - .via( - ZPipeline.fromChannel( - (ZPipeline.utf8Decode >>> ZPipeline.splitLines).channel - .mapError(UnknownProxError.apply) - ) - ) - .map(_.split(' ').toVector) - .map(v => v.map(_ + " !!!").mkString(" ")) - .intersperse("\n") - .flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val processGroup = Process("echo", List("This is a test string")) - .via(customPipe) - .to(Process("wc", List("-w"))) ># ZPipeline.utf8Decode - val program = processGroup.run().map(_.output.trim) - - program.map(r => assertTrue(r == "10")) - }, - test("can be mapped") { - import zstream.Process.* - - val processGroup1 = (Process( - "!echo", - List("This is a test string") - ) | Process("!wc", List("-w"))) ># ZPipeline.utf8Decode - val processGroup2 = - processGroup1.map(new ProcessGroup.Mapper[String, Unit] { - override def mapFirst[ - P <: Process[zstream.ProxStream[Byte], Unit] - ](process: P): P = - process.withCommand(process.command.tail).asInstanceOf[P] - - override def mapInnerWithIdx[ - P <: UnboundIProcess[zstream.ProxStream[Byte], Unit] - ](process: P, idx: Int): P = - process.withCommand(process.command.tail).asInstanceOf[P] - - override def mapLast[P <: UnboundIProcess[String, Unit]]( - process: P - ): P = process.withCommand(process.command.tail).asInstanceOf[P] - }) - - val program = processGroup2.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - } - ), - suite("Termination")( - test("can be terminated with cancellation") { - - val processGroup = - Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) | - Process("sort") - val program = ZIO.scoped { - processGroup.start().flatMap { fiber => fiber.interrupt.unit } - } - - program.as(assertCompletes) - } @@ TestAspect.timeout(5.seconds), - test("can be terminated") { - - val p1 = Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) - val p2 = Process("sort") - val processGroup = p1 | p2 - - val program = for { - runningProcesses <- processGroup.startProcessGroup() - _ <- ZIO.sleep(250.millis) - result <- runningProcesses.terminate() - } yield result.exitCodes.toList - - program.map(r => - assert(r)( - contains[(Process[Unit, Unit], ProxExitCode)](p1 -> ExitCode(1)) - ) - ) - } @@ withLiveClock, - test("can be killed") { - - val p1 = Process( - "perl", - List("-e", """$SIG{TERM} = 'IGNORE'; sleep 30; exit 2""") - ) - val p2 = Process("sort") - val processGroup = p1 | p2 - - val program = for { - runningProcesses <- processGroup.startProcessGroup() - _ <- ZIO.sleep(250.millis) - result <- runningProcesses.kill() - } yield result.exitCodes - - // Note: we can't assert on the second process' exit code because there is a race condition - // between killing it directly and being stopped because of the upstream process got killed. - program.map(r => assert(r)(contains(p1 -> ExitCode(137)))) - } @@ withLiveClock - ), - suite("Input redirection")( - test("can be fed with an input stream") { - - val stream = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val processGroup = (Process("cat") | Process( - "wc", - List("-w") - )) < stream ># ZPipeline.utf8Decode - val program = processGroup.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - }, - test("can be fed with an input file") { - - withTempFile { tempFile => - val program = for { - _ <- ZIO - .attempt( - Files.write( - tempFile.toPath, - "This is a test string".getBytes("UTF-8") - ) - ) - .mapError(UnknownProxError.apply) - processGroup = (Process("cat") | Process( - "wc", - List("-w") - )) < tempFile.toPath ># ZPipeline.utf8Decode - result <- processGroup.run() - } yield result.output.trim - - program.map(r => assertTrue(r == "5")) - } - } - ), - suite("Output redirection")( - test("output can be redirected to file") { - - withTempFile { tempFile => - val processGroup = (Process( - "echo", - List("This is a test string") - ) | Process("wc", List("-w"))) > tempFile.toPath - val program = for { - _ <- processGroup.run() - contents <- ZStream - .fromFile(tempFile, 1024) - .via(ZPipeline.utf8Decode) - .runFold("")(_ + _) - .mapError(UnknownProxError.apply) - } yield contents.trim - - program.map(r => assertTrue(r == "5")) - } - } - ), - suite("Error redirection")( - test("can redirect each error output to a stream") { - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2) !># ZPipeline.utf8Decode - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo("world"))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - test("can redirect each error output to a sink") { - - val builder = new StringBuilder - val target: zstream.ProxSink[Byte] = ZSink.foreach((byte: Byte) => - ZIO - .attempt(builder.append(byte.toChar)) - .mapError(UnknownProxError.apply) - ) - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2) !> target - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo(()))) && - assert(result.errors.get(p2))(isSome(equalTo(()))) && - assert(result.output)(equalTo(())) && - assert(builder.toString.toSeq.sorted)( - equalTo("Helloworld".toSeq.sorted) - ) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - test("can redirect each error output to a vector") { - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world!"""")) - - val stream = - ZPipeline.utf8Decode >>> ZPipeline.splitLines >>> ZPipeline - .map[String, Int](_.length) - - val processGroup = (p1 | p2) !>? stream - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(hasSameElements(List(5)))) && - assert(result.errors.get(p2))(isSome(hasSameElements(List(6)))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - test("can drain each error output") { - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2) drainErrors ZPipeline.utf8Decode - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo(()))) && - assert(result.errors.get(p2))(isSome(equalTo(()))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - test("can fold each error output") { - - val p1 = Process("perl", List("-e", "print STDERR 'Hello\nworld'")) - val p2 = Process("perl", List("-e", "print STDERR 'Does\nit\nwork?'")) - val processGroup = (p1 | p2).foldErrors( - ZPipeline.utf8Decode >>> ZPipeline.splitLines, - Vector.empty, - (l: Vector[Option[Char]], s: String) => l :+ s.headOption - ) - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))( - isSome(equalTo(Vector(Some('H'), Some('w')))) - ) && - assert(result.errors.get(p2))( - isSome(equalTo(Vector(Some('D'), Some('i'), Some('w')))) - ) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - } - ), - suite("Error redirection customized per process")( - test( - "can redirect each error output to a stream customized per process" - ) { - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2).customizedPerProcess.errorsToFoldMonoid { - case p if p == p1 => - ZPipeline.utf8Decode >>> ZPipeline.map(s => "P1: " + s) - case p if p == p2 => - ZPipeline.utf8Decode >>> ZPipeline.map(s => "P2: " + s) - } - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo("P1: HelloP1: "))) && - assert(result.errors.get(p2))(isSome(equalTo("P2: worldP2: "))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - test( - "can redirect each error output to a sink customized per process" - ) { - - val builder1 = new StringBuilder - val builder2 = new StringBuilder - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2).customizedPerProcess.errorsToSink { - case p if p == p1 => - ZSink.foreach((byte: Byte) => - ZIO - .attempt(builder1.append(byte.toChar)) - .mapError(UnknownProxError.apply) - ) - case p if p == p2 => - ZSink.foreach((byte: Byte) => - ZIO - .attempt(builder2.append(byte.toChar)) - .mapError(UnknownProxError.apply) - ) - } - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo(()))) && - assert(result.errors.get(p2))(isSome(equalTo(()))) && - assert(result.output)(equalTo(())) && - assert(builder1.toString)(equalTo("Hello")) && - assert(builder2.toString)(equalTo("world")) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - test( - "can redirect each error output to a vector customized per process" - ) { - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world!"""")) - - val stream = - ZPipeline.utf8Decode >>> ZPipeline.splitLines >>> ZPipeline - .map[String, Int](_.length) - - val processGroup = (p1 | p2).customizedPerProcess.errorsToVector { - case p if p == p1 => stream >>> ZPipeline.map(l => (1, l)) - case p if p == p2 => stream >>> ZPipeline.map(l => (2, l)) - } - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))( - isSome(hasSameElements(List((1, 5)))) - ) && - assert(result.errors.get(p2))( - isSome(hasSameElements(List((2, 6)))) - ) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - test("can drain each error output customized per process") { - - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2).customizedPerProcess.drainErrors(_ => - ZPipeline.utf8Decode - ) - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))(isSome(equalTo(()))) && - assert(result.errors.get(p2))(isSome(equalTo(()))) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - test("can fold each error output customized per process") { - - val p1 = Process("perl", List("-e", "print STDERR 'Hello\nworld'")) - val p2 = Process("perl", List("-e", "print STDERR 'Does\nit\nwork?'")) - val processGroup = (p1 | p2).customizedPerProcess.foldErrors( - { - case p if p == p1 => ZPipeline.utf8Decode >>> ZPipeline.splitLines - case p if p == p2 => - ZPipeline.utf8Decode >>> ZPipeline.splitLines >>> ZPipeline - .map[String, String](_.reverse) - }, - Vector.empty, - (l: Vector[Option[Char]], s: String) => l :+ s.headOption - ) - val program = processGroup.run() - - program.map { result => - assert(result.errors.get(p1))( - isSome(equalTo(Vector(Some('H'), Some('w')))) - ) && - assert(result.errors.get(p2))( - isSome(equalTo(Vector(Some('s'), Some('t'), Some('?')))) - ) && - assert(result.output)(equalTo(())) && - assert(result.exitCodes.get(p1))(isSome(equalTo(ExitCode(0)))) && - assert(result.exitCodes.get(p2))(isSome(equalTo(ExitCode(0)))) - } - }, - test("can redirect each error output to file") { - - withTempFile { tempFile1 => - withTempFile { tempFile2 => - val p1 = Process("perl", List("-e", """print STDERR "Hello"""")) - val p2 = Process("perl", List("-e", """print STDERR "world"""")) - val processGroup = (p1 | p2).customizedPerProcess.errorsToFile { - case p if p == p1 => tempFile1.toPath - case p if p == p2 => tempFile2.toPath - } - val program = for { - _ <- processGroup.run() - contents1 <- ZStream - .fromFile(tempFile1, 1024) - .via(ZPipeline.utf8Decode) - .runFold("")(_ + _) - .mapError(UnknownProxError.apply) - contents2 <- ZStream - .fromFile(tempFile2, 1024) - .via(ZPipeline.utf8Decode) - .runFold("")(_ + _) - .mapError(UnknownProxError.apply) - } yield (contents1, contents2) - - program.map(r => assertTrue(r == ("Hello", "world"))) - } - } - } - ), - suite("Redirection ordering")( - test( - "can redirect each error output to a stream if fed with an input stream and redirected to an output stream" - ) { - - val stream = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - (p1 | p2 | p3) < stream ># ZPipeline.utf8Decode !># ZPipeline.utf8Decode - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - test( - "can redirect output if each error output and input are already redirected" - ) { - - val stream = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - ((p1 | p2 | p3) < stream !># ZPipeline.utf8Decode) ># ZPipeline.utf8Decode - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - test( - "can attach output and then input stream if each error output and standard output are already redirected" - ) { - - val stream = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - ((p1 | p2 | p3) !># ZPipeline.utf8Decode) ># ZPipeline.utf8Decode < stream - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - test( - "can attach input and then output stream if each error output and standard output are already redirected" - ) { - - val stream = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - ((p1 | p2 | p3) !># ZPipeline.utf8Decode) < stream ># ZPipeline.utf8Decode - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - test( - "can attach input stream and errors if standard output is already redirected" - ) { - - val stream = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - ((p1 | p2 | p3) ># ZPipeline.utf8Decode) < stream !># ZPipeline.utf8Decode - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - }, - test( - "can attach errors and finally input stream if standard output is already redirected" - ) { - - val stream = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val p1 = Process( - "perl", - List( - "-e", - """my $str=<>; print STDERR Hello; print STDOUT "$str"""" - ) - ) - val p2 = Process("sort") - val p3 = Process("wc", List("-w")) - val processGroup = - (((p1 | p2 | p3) ># ZPipeline.utf8Decode) !># ZPipeline.utf8Decode) < stream - - processGroup - .run() - .map { result => - assert(result.errors.get(p1))(isSome(equalTo("Hello"))) && - assert(result.errors.get(p2))(isSome(equalTo(""))) && - assert(result.errors.get(p3))(isSome(equalTo(""))) && - assert(result.output.trim)(equalTo("5")) - } - } - ), - test("bound process is not pipeable") { - assertZIO( - typeCheck( - """val bad = (Process("echo", List("Hello world")) ># ZPipeline.utf8Decode) | Process("wc", List("-w"))""" - ) - )( - isLeft(anything) - ) - } - ) @@ timeoutWarning(60.seconds) @@ sequential -} diff --git a/prox-zstream-2/src/test/scala/io/github/vigoo/prox/tests/zstream/ProcessSpecs.scala b/prox-zstream-2/src/test/scala/io/github/vigoo/prox/tests/zstream/ProcessSpecs.scala deleted file mode 100644 index 92f2eb3c..00000000 --- a/prox-zstream-2/src/test/scala/io/github/vigoo/prox/tests/zstream/ProcessSpecs.scala +++ /dev/null @@ -1,589 +0,0 @@ -package io.github.vigoo.prox.tests.zstream - -import io.github.vigoo.prox.zstream.* -import io.github.vigoo.prox.{UnknownProxError, zstream} -import zio.stream.{ZPipeline, ZSink, ZStream} -import zio.test.* -import zio.test.Assertion.{anything, equalTo, hasSameElements, isLeft} -import zio.test.TestAspect.* -import zio.* - -import java.nio.charset.StandardCharsets -import java.nio.file.Files - -object ProcessSpecs extends ZIOSpecDefault with ProxSpecHelpers { - implicit val processRunner: ProcessRunner[JVMProcessInfo] = - new JVMProcessRunner - - override val spec: Spec[TestEnvironment & Scope, Any] = - suite("Executing a process")( - test("returns the exit code") { - val program = for { - trueResult <- Process("true").run() - falseResult <- Process("false").run() - } yield (trueResult.exitCode, falseResult.exitCode) - - program.map(r => assertTrue(r == (ExitCode(0), ExitCode(1)))) - }, - suite("Output redirection")( - test("can redirect output to a file") { - withTempFile { tempFile => - val process = - Process("echo", List("Hello world!")) > tempFile.toPath - val program = for { - _ <- process.run() - contents <- ZStream - .fromFile(tempFile, 1024) - .via(ZPipeline.utf8Decode) - .runFold("")(_ + _) - .mapError(UnknownProxError.apply) - } yield contents - - program.map(r => assertTrue(r == "Hello world!\n")) - } - }, - test("can redirect output to append a file") { - withTempFile { tempFile => - val process1 = Process("echo", List("Hello")) > tempFile.toPath - val process2 = Process("echo", List("world")) >> tempFile.toPath - val program = for { - _ <- process1.run() - _ <- process2.run() - contents <- ZStream - .fromFile(tempFile, 1024) - .via(ZPipeline.utf8Decode) - .runFold("")(_ + _) - .mapError(UnknownProxError.apply) - } yield contents - - program.map(r => assertTrue(r == "Hello\nworld\n")) - } - }, - test("can redirect output to stream") { - val process = - Process("echo", List("Hello world!")) ># ZPipeline.utf8Decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world!\n")) - }, - test("can redirect output to stream folding monoid") { - val process = Process( - "echo", - List("Hello\nworld!") - ) ># (ZPipeline.utf8Decode >>> ZPipeline.splitLines) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Helloworld!")) - }, - test("can redirect output to stream collected to vector") { - case class StringLength(value: Int) - - val stream = - ZPipeline.utf8Decode >>> - ZPipeline.splitLines >>> - ZPipeline.map[String, StringLength](s => StringLength(s.length)) - - val process = Process("echo", List("Hello\nworld!")) >? stream - val program = process.run().map(_.output) - - program.map(r => - assert(r)( - hasSameElements(List(StringLength(5), StringLength(6))) - ) - ) - }, - test("can redirect output to stream and ignore it's result") { - val process = Process("echo", List("Hello\nworld!")) - .drainOutput(ZPipeline.utf8Decode >>> ZPipeline.splitLines) - val program = process.run().map(_.output) - - program.as(assertCompletes) - }, - test("can redirect output to stream and fold it") { - val process = Process("echo", List("Hello\nworld!")).foldOutput( - ZPipeline.utf8Decode >>> ZPipeline.splitLines, - Vector.empty, - (l: Vector[Option[Char]], s: String) => l :+ s.headOption - ) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == Vector(Some('H'), Some('w')))) - }, - test("can redirect output to a sink") { - val builder = new StringBuilder - val target: zstream.ProxSink[Byte] = ZSink.foreach((byte: Byte) => - ZIO - .attempt(builder.append(byte.toChar)) - .mapError(UnknownProxError.apply) - ) - - val process = Process("echo", List("Hello world!")) > target - val program = process.run().as(builder.toString) - - program.map(r => assertTrue(r == "Hello world!\n")) - } - ), - suite("Error redirection")( - test("can redirect error to a file") { - withTempFile { tempFile => - val process = Process( - "perl", - List("-e", "print STDERR 'Hello world!'") - ) !> tempFile.toPath - val program = for { - _ <- process.run() - contents <- ZStream - .fromFile(tempFile, 1024) - .via(ZPipeline.utf8Decode) - .runFold("")(_ + _) - .mapError(UnknownProxError.apply) - } yield contents - - program.map(r => assertTrue(r == "Hello world!")) - } - }, - test("can redirect error to append a file") { - withTempFile { tempFile => - val process1 = Process( - "perl", - List("-e", "print STDERR Hello") - ) !> tempFile.toPath - val process2 = Process( - "perl", - List("-e", "print STDERR world") - ) !>> tempFile.toPath - val program = for { - _ <- process1.run() - _ <- process2.run() - contents <- ZStream - .fromFile(tempFile, 1024) - .via(ZPipeline.utf8Decode) - .runFold("")(_ + _) - .mapError(UnknownProxError.apply) - } yield contents - - program.map(r => assertTrue(r == "Helloworld")) - } - }, - test("can redirect error to stream") { - val process = Process( - "perl", - List("-e", """print STDERR "Hello"""") - ) !># ZPipeline.utf8Decode - val program = process.run().map(_.error) - - program.map(r => assertTrue(r == "Hello")) - }, - test("can redirect error to stream folding monoid") { - val process = Process( - "perl", - List("-e", "print STDERR 'Hello\nworld!'") - ) !># (ZPipeline.utf8Decode >>> ZPipeline.splitLines) - val program = process.run().map(_.error) - - program.map(r => assertTrue(r == "Helloworld!")) - }, - test("can redirect error to stream collected to vector") { - case class StringLength(value: Int) - - val stream = - ZPipeline.utf8Decode >>> - ZPipeline.splitLines >>> - ZPipeline.map[String, StringLength](s => StringLength(s.length)) - - val process = Process( - "perl", - List("-e", "print STDERR 'Hello\nworld!'") - ) !>? stream - val program = process.run().map(_.error) - - program.map(r => - assert(r)( - hasSameElements(List(StringLength(5), StringLength(6))) - ) - ) - }, - test("can redirect error to stream and ignore it's result") { - val process = - Process("perl", List("-e", "print STDERR 'Hello\nworld!'")) - .drainError(ZPipeline.utf8Decode >>> ZPipeline.splitLines) - val program = process.run().map(_.error) - - program.as(assertCompletes) - }, - test("can redirect error to stream and fold it") { - val process = Process( - "perl", - List("-e", "print STDERR 'Hello\nworld!'") - ).foldError( - ZPipeline.utf8Decode >>> ZPipeline.splitLines, - Vector.empty, - (l: Vector[Option[Char]], s: String) => l :+ s.headOption - ) - val program = process.run().map(_.error) - - program.map(r => assertTrue(r == Vector(Some('H'), Some('w')))) - }, - test("can redirect error to a sink") { - val builder = new StringBuilder - val target: zstream.ProxSink[Byte] = ZSink.foreach((byte: Byte) => - ZIO - .attempt(builder.append(byte.toChar)) - .mapError(UnknownProxError.apply) - ) - - val process = - Process("perl", List("-e", """print STDERR "Hello"""")) !> target - val program = process.run().as(builder.toString) - - program.map(r => assertTrue(r == "Hello")) - } - ), - suite("Redirection ordering")( - test("can redirect first input and then error to stream") { - val source = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = Process( - "perl", - List("-e", """my $str = <>; print STDERR "$str"""".stripMargin) - ) < source !># ZPipeline.utf8Decode - val program = process.run().map(_.error) - - program.map(r => assertTrue(r == "This is a test string")) - }, - test("can redirect error first then output to stream") { - val process = (Process( - "perl", - List("-e", """print STDOUT Hello; print STDERR World""".stripMargin) - ) !># ZPipeline.utf8Decode) ># ZPipeline.utf8Decode - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - }, - test("can redirect output first then error to stream") { - val process = (Process( - "perl", - List("-e", """print STDOUT Hello; print STDERR World""".stripMargin) - ) ># ZPipeline.utf8Decode) !># ZPipeline.utf8Decode - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - }, - test("can redirect output first then error finally input to stream") { - val source = ZStream("Hello").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = ((Process( - "perl", - List( - "-e", - """my $str = <>; print STDOUT "$str"; print STDERR World""".stripMargin - ) - ) - ># ZPipeline.utf8Decode) - !># ZPipeline.utf8Decode) < source - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - }, - test("can redirect output first then input finally error to stream") { - val source = ZStream("Hello").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = ((Process( - "perl", - List( - "-e", - """my $str = <>; print STDOUT "$str"; print STDERR World""".stripMargin - ) - ) - ># ZPipeline.utf8Decode) - < source) !># ZPipeline.utf8Decode - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - }, - test("can redirect input first then error finally output to stream") { - val source = ZStream("Hello").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = ((Process( - "perl", - List( - "-e", - """my $str = <>; print STDOUT "$str"; print STDERR World""".stripMargin - ) - ) - < source) - !># ZPipeline.utf8Decode) ># ZPipeline.utf8Decode - val program = process.run().map(r => r.output + r.error) - - program.map(r => assertTrue(r == "HelloWorld")) - } - ), - suite("Input redirection")( - test("can use stream as input") { - val source = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = - Process("wc", List("-w")) < source ># ZPipeline.utf8Decode - val program = process.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - }, - test("can use stream as input flushing after each chunk") { - val source = ZStream("This ", "is a test", " string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = - (Process("wc", List("-w")) !< source) ># ZPipeline.utf8Decode - val program = process.run().map(_.output.trim) - - program.map(r => assertTrue(r == "5")) - } - ), - suite("Termination")( - test("can be terminated with cancellation") { - val process = Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) - val program = ZIO.scoped { - process.start().flatMap { fiber => - fiber.interrupt.unit.delay(250.millis) - } - } - - program.as(assertCompletes) - } @@ TestAspect.withLiveClock @@ TestAspect.timeout( - 5.seconds - ) @@ TestAspect.diagnose(2.seconds), - test("can be terminated by releasing the resource") { - val process = Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) - val program = ZIO.scoped { - process.start() *> ZIO.sleep(250.millis) - } - - program.as(assertCompletes) - } @@ TestAspect.withLiveClock @@ TestAspect.timeout(5.seconds), - test("can be terminated") { - val process = Process( - "perl", - List("-e", """$SIG{TERM} = sub { exit 1 }; sleep 30; exit 0""") - ) - val program = for { - runningProcess <- process.startProcess() - _ <- ZIO.sleep(250.millis) - result <- runningProcess.terminate() - } yield result.exitCode - - program.map(r => assertTrue(r == ExitCode(1))) - } @@ withLiveClock, - test("can be killed") { - val process = Process( - "perl", - List("-e", """$SIG{TERM} = 'IGNORE'; sleep 30; exit 2""") - ) - val program = for { - runningProcess <- process.startProcess() - _ <- ZIO.sleep(250.millis) - result <- runningProcess.kill() - } yield result.exitCode - - program.map(r => assertTrue(r == ExitCode(137))) - } @@ withLiveClock, - test("can be checked if is alive") { - val process = Process("sleep", List("10")) - val program = for { - runningProcess <- process.startProcess() - isAliveBefore <- runningProcess.isAlive - _ <- runningProcess.terminate() - isAliveAfter <- runningProcess.isAlive - } yield (isAliveBefore, isAliveAfter) - - program.map(r => assertTrue(r == (true, false))) - } - ), - suite("Customization")( - test("can change the command") { - val p1 = - Process("something", List("Hello", "world")) ># ZPipeline.utf8Decode - val p2 = p1.withCommand("echo") - val program = p2.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world\n")) - }, - test("can change the arguments") { - val p1 = Process("echo") ># ZPipeline.utf8Decode - val p2 = p1.withArguments(List("Hello", "world")) - val program = p2.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world\n")) - }, - test("respects the working directory") { - ZIO.attempt(Files.createTempDirectory("prox")).flatMap { - tempDirectory => - val process = - (Process("pwd") in tempDirectory) ># ZPipeline.utf8Decode - val program = process.run().map(_.output.trim) - - program.map(r => - assert(r)( - equalTo(tempDirectory.toString) || equalTo( - s"/private${tempDirectory}" - ) - ) - ) - } - }, - test("is customizable with environment variables") { - val process = - (Process("sh", List("-c", "echo \"Hello $TEST1! I am $TEST2!\"")) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) ># ZPipeline.utf8Decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - test("is customizable with excluded environment variables") { - val process = - (Process("sh", List("-c", "echo \"Hello $TEST1! I am $TEST2!\"")) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox") - `without` "TEST1") ># ZPipeline.utf8Decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello ! I am prox!\n")) - }, - test("is customizable with environment variables output is bound") { - val process = (Process( - "sh", - List("-c", "echo \"Hello $TEST1! I am $TEST2!\"") - ) ># ZPipeline.utf8Decode - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - test("is customizable with environment variables if input is bound") { - val source = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = ((Process( - "sh", - List("-c", "cat > /dev/null; echo \"Hello $TEST1! I am $TEST2!\"") - ) < source) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) ># ZPipeline.utf8Decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - test("is customizable with environment variables if error is bound") { - val process = ((Process( - "sh", - List("-c", "echo \"Hello $TEST1! I am $TEST2!\"") - ) !># ZPipeline.utf8Decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) ># ZPipeline.utf8Decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - test( - "is customizable with environment variables if input and output are bound" - ) { - val source = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = (((Process( - "sh", - List("-c", "cat > /dev/null; echo \"Hello $TEST1! I am $TEST2!\"") - ) < source) ># ZPipeline.utf8Decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - test( - "is customizable with environment variables if input and error are bound" - ) { - val source = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = (((Process( - "sh", - List("-c", "cat > /dev/null; echo \"Hello $TEST1! I am $TEST2!\"") - ) < source) !># ZPipeline.utf8Decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) ># ZPipeline.utf8Decode - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - test( - "is customizable with environment variables if output and error are bound" - ) { - val process = (((Process( - "sh", - List("-c", "echo \"Hello $TEST1! I am $TEST2!\"") - ) !># ZPipeline.utf8Decode) ># ZPipeline.utf8Decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - }, - test( - "is customizable with environment variables if everything is bound" - ) { - val source = ZStream("This is a test string").flatMap(s => - ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)) - ) - val process = ((((Process( - "sh", - List("-c", "cat > /dev/null; echo \"Hello $TEST1! I am $TEST2!\"") - ) < source) !># ZPipeline.utf8Decode) ># ZPipeline.utf8Decode) - `with` ("TEST1" -> "world") - `with` ("TEST2" -> "prox")) - val program = process.run().map(_.output) - - program.map(r => assertTrue(r == "Hello world! I am prox!\n")) - } - ), - test("double output redirect is illegal") { - assertZIO( - typeCheck( - """val bad = Process("echo", List("Hello world")) > new File("x").toPath > new File("y").toPath""" - ) - )( - isLeft(anything) - ) - }, - test("double error redirect is illegal") { - assertZIO( - typeCheck( - """val bad = Process("echo", List("Hello world")) !> new File("x").toPath !> new File("y").toPath""" - ) - )( - isLeft(anything) - ) - }, - test("double input redirect is illegal") { - assertZIO( - typeCheck( - """val bad = (Process("echo", List("Hello world")) < ZStream("X").flatMap(s => ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)))) < ZStream("Y").flatMap(s => ZStream.fromIterable(s.getBytes(StandardCharsets.UTF_8)))""" - ) - )( - isLeft(anything) - ) - } - ) @@ timeout(60.seconds) @@ sequential -} diff --git a/prox-zstream-2/src/test/scala/io/github/vigoo/prox/tests/zstream/ProxSpecHelpers.scala b/prox-zstream-2/src/test/scala/io/github/vigoo/prox/tests/zstream/ProxSpecHelpers.scala deleted file mode 100644 index 47208b88..00000000 --- a/prox-zstream-2/src/test/scala/io/github/vigoo/prox/tests/zstream/ProxSpecHelpers.scala +++ /dev/null @@ -1,18 +0,0 @@ -package io.github.vigoo.prox.tests.zstream - -import java.io.File - -import io.github.vigoo.prox.{ProxError, UnknownProxError} -import zio.ZIO - -trait ProxSpecHelpers { - - def withTempFile[A]( - inner: File => ZIO[Any, ProxError, A] - ): ZIO[Any, ProxError, A] = - ZIO.acquireReleaseWith( - ZIO - .attempt(File.createTempFile("test", "txt")) - .mapError(UnknownProxError.apply) - )(file => ZIO.attempt(file.delete()).orDie)(inner) -} diff --git a/robots.txt b/robots.txt new file mode 100644 index 00000000..e597c3dc --- /dev/null +++ b/robots.txt @@ -0,0 +1 @@ +Sitemap: https://vigoo.github.io/prox/sitemap.xml diff --git a/scripts/decrypt_keys.sh b/scripts/decrypt_keys.sh deleted file mode 100644 index 74c56ab2..00000000 --- a/scripts/decrypt_keys.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/sh -x - -openssl aes-256-cbc -K $encrypted_4abe426e5bff_key -iv $encrypted_4abe426e5bff_iv -in travis-deploy-key.enc -out travis-deploy-key -d -chmod 600 travis-deploy-key -cp travis-deploy-key ~/.ssh/id_rsa diff --git a/scripts/publish_microsite.sh b/scripts/publish_microsite.sh deleted file mode 100644 index 77feb262..00000000 --- a/scripts/publish_microsite.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/sh -x - -set -e - -git config --global user.email "daniel.vigovszky@gmail.com" -git config --global user.name "Daniel Vigovszky" -git config --global push.default simple - -sbt docs/publishMicrosite diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 00000000..7689c9b8 --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,51 @@ + + + +https://vigoo.github.io/prox/docs/blogposts.html + + +https://vigoo.github.io/prox/docs/zstream/custom-runners.html + + +https://vigoo.github.io/prox/docs/fs2/custom-runners.html + + +https://vigoo.github.io/prox/docs/zstream/customize.html + + +https://vigoo.github.io/prox/docs/fs2/customize.html + + +https://vigoo.github.io/prox/docs/zstream/ + + +https://vigoo.github.io/prox/docs/fs2/ + + +https://vigoo.github.io/prox/docs/ + + +https://vigoo.github.io/prox/ + + +https://vigoo.github.io/prox/docs/migration.html + + +https://vigoo.github.io/prox/docs/zstream/processgroups.html + + +https://vigoo.github.io/prox/docs/fs2/processgroups.html + + +https://vigoo.github.io/prox/docs/zstream/redirection.html + + +https://vigoo.github.io/prox/docs/fs2/redirection.html + + +https://vigoo.github.io/prox/docs/zstream/running.html + + +https://vigoo.github.io/prox/docs/fs2/running.html + +