chore: prepare v2.1.6

LICENSE

@@ -0,0 +1,675 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "purescript-node-stream-pipes",
-  "version": "v2.0.0",
+  "version": "v2.1.6",
   "type": "module",
   "dependencies": {
     "csv-parse": "^5.5.6",

spago.lock

@@ -20,7 +20,7 @@ workspace:
         - newtype: ">=5.0.0 <6.0.0"
         - node-buffer: ">=9.0.0 <10.0.0"
         - node-event-emitter: ">=3.0.0 <4.0.0"
-        - node-fs: ">=9.1.0 <10.0.0"
+        - node-fs: ">=9.1.0 <9.2.0"
         - node-path: ">=5.0.0 <6.0.0"
         - node-streams: ">=9.0.0 <10.0.0"
         - node-zlib: ">=0.4.0 <0.5.0"
@@ -302,8 +302,8 @@ packages:
       - unfoldable
   exceptions:
     type: registry
-    version: 6.0.0
+    version: 6.1.0
-    integrity: sha256-y/xTAEIZIARCE+50/u1di0ncebJ+CIwNOLswyOWzMTw=
+    integrity: sha256-K0T89IHtF3vBY7eSAO7eDOqSb2J9kZGAcDN5+IKsF8E=
     dependencies:
       - effect
       - either
@@ -867,8 +867,8 @@ packages:
       - refs
   transformers:
     type: registry
-    version: 6.0.0
+    version: 6.1.0
-    integrity: sha256-Pzw40HjthX77tdPAYzjx43LK3X5Bb7ZspYAp27wksFA=
+    integrity: sha256-3Bm+Z6tsC/paG888XkywDngJ2JMos+JfOhRlkVfb7gI=
     dependencies:
       - control
       - distributive
@@ -881,6 +881,7 @@ packages:
       - maybe
       - newtype
       - prelude
+      - st
       - tailrec
       - tuples
       - unfoldable

spago.yaml

@@ -1,7 +1,7 @@
 package:
   name: node-stream-pipes
   publish:
-    version: '2.0.0'
+    version: '2.1.6'
     license: 'GPL-3.0-or-later'
     location:
       githubOwner: 'cakekindel'
@@ -27,7 +27,7 @@ package:
     - newtype: ">=5.0.0 <6.0.0"
     - node-buffer: ">=9.0.0 <10.0.0"
     - node-event-emitter: ">=3.0.0 <4.0.0"
-    - node-fs: ">=9.1.0 <10.0.0"
+    - node-fs: ">=9.1.0 <9.2.0"
     - node-path: ">=5.0.0 <6.0.0"
     - node-streams: ">=9.0.0 <10.0.0"
     - node-zlib: ">=0.4.0 <0.5.0"

src/Node.Stream.Object.purs

@@ -191,9 +191,17 @@ awaitReadableOrClosed s = Aff.supervise do
 
 awaitFinished :: forall s a. Write s a => s -> Aff Unit
 awaitFinished s = Aff.supervise do
-  fiber <- Aff.forkAff $ onceAff0 finishH s
+  fiber <-
+    Aff.forkAff
+    $ parOneOf
+        [ onceAff0 finishH s $> Right unit
+        , Left <$> onceAff1 errorH s
+        ]
   finished <- liftEffect $ isWritableFinished s
-  if not finished then Aff.joinFiber fiber else Aff.killFiber (error "") fiber
+  if not finished then
+    liftEither =<< Aff.joinFiber fiber
+  else
+    Aff.killFiber (error "") fiber
 
 awaitWritableOrClosed :: forall s a. Write s a => s -> Aff Unit
 awaitWritableOrClosed s = Aff.supervise do

src/Pipes.Async.purs

@@ -3,40 +3,41 @@ module Pipes.Async where
 import Prelude hiding (join)
 
 import Control.Alternative (class Alternative, empty, guard)
-import Control.Monad.Error.Class (class MonadError, catchError, throwError)
+import Control.Monad.Cont (class MonadTrans)
+import Control.Monad.Error.Class (class MonadError, class MonadThrow, catchError, throwError)
 import Control.Monad.Except (ExceptT, runExceptT)
 import Control.Monad.Fork.Class (class MonadBracket, class MonadFork, fork)
-import Control.Monad.Maybe.Trans (runMaybeT)
+import Control.Monad.Maybe.Trans (MaybeT(..), runMaybeT)
-import Control.Monad.Morph (hoist)
+import Control.Monad.Morph (class MFunctor, hoist)
-import Control.Monad.Rec.Class (class MonadRec, Step(..), forever, tailRecM)
+import Control.Monad.Rec.Class (class MonadRec, Step(..), tailRecM)
 import Control.Monad.ST.Class (liftST)
 import Control.Monad.ST.Ref (STRef)
 import Control.Monad.ST.Ref as ST.Ref
 import Control.Monad.Trans.Class (lift)
 import Control.Parallel (class Parallel, parOneOf)
-import Data.Array (fold)
 import Data.Array as Array
 import Data.DateTime.Instant as Instant
 import Data.Either (Either(..), either)
+import Data.Foldable (class Foldable, fold)
 import Data.Generic.Rep (class Generic)
-import Data.Maybe (Maybe(..), isNothing)
+import Data.Maybe (Maybe(..), fromMaybe, isNothing)
 import Data.Newtype (unwrap)
 import Data.Show.Generic (genericShow)
 import Data.Time.Duration (Milliseconds)
-import Data.Traversable (traverse_)
+import Data.Traversable (class Traversable, traverse, traverse_)
 import Data.Tuple.Nested (type (/\), (/\))
-import Effect.Aff.Class (class MonadAff)
+import Effect.Aff.Class (class MonadAff, liftAff)
-import Effect.Class (liftEffect)
+import Effect.Class (class MonadEffect, liftEffect)
 import Effect.Console (log)
-import Effect.Exception (Error)
 import Effect.Now as Now
 import Pipes (await, yield)
 import Pipes.Collect as Collect
-import Pipes.Core (Pipe, Producer, Proxy)
+import Pipes.Core (Pipe, Proxy, Producer)
 
 data WriteSignal
   = WriteSignalOk
   | WriteSignalEnded
+
 derive instance Generic WriteSignal _
 derive instance Eq WriteSignal
 derive instance Ord WriteSignal
@@ -61,6 +62,7 @@ data WriteResult
   = WriteAgain
   | WriteNeedsDrain
   | WriteEnded
+
 derive instance Generic WriteResult _
 derive instance Eq WriteResult
 derive instance Ord WriteResult
@@ -69,83 +71,160 @@ instance Show WriteResult where show = genericShow
 data ReadResult a
   = ReadOk a
   | ReadWouldBlock
+
 derive instance Generic (ReadResult a) _
 derive instance Eq a => Eq (ReadResult a)
 derive instance Ord a => Ord (ReadResult a)
 derive instance Functor ReadResult
+derive instance Foldable ReadResult
+derive instance Traversable ReadResult
 instance Show a => Show (ReadResult a) where show = genericShow
 
+type AsyncIO a b m r =
+  { write :: a -> m WriteResult
+  , read :: m (ReadResult b)
+  , awaitWrite :: m WriteSignal
+  , awaitRead :: m ReadSignal
+  }
+  /\ AsyncPipe a b m r
+
 -- | An `AsyncPipe` is a `Pipe`-like struct that allows
 -- | concurrently reading from a `Producer` and writing to a `Consumer`.
 -- |
 -- | An implementation of `AsyncPipe` for Node `Transform` streams
 -- | is provided in `Pipes.Node.Stream`.
--- |
+data AsyncPipe a b m r
--- | ## Fields
+  -- | A pure return value
--- | - `m x`
+  = Pure r
--- |    - Initializer
+  -- | An `AsyncPipe` behind a computation
--- | - `x -> a -> m WriteResult`
+  | M (m (AsyncPipe a b m r))
--- |    - Write a value `a` to the underlying resource
+  -- | Interface to write & read from the backing resource
--- | - `x -> m WriteSignal`
+  | AsyncIO (AsyncIO a b m r)
--- |    - Block until the pipe is writable again (or writing must stop)
+
--- | - `x -> m (ReadResult b)`
+-- | Modify request / response types
--- |    - Attempt to read a chunk
+mapIO :: forall aa ab ba bb m r. Monad m => (ab -> aa) -> (ba -> bb) -> AsyncPipe aa ba m r -> AsyncPipe ab bb m r
--- | - `x -> m ReadSignal`
+mapIO _ _ (Pure a) = Pure a
--- |    - Block until the pipe is readable again (or reading must stop)
+mapIO a b (M m) = M $ mapIO a b <$> m
-data AsyncPipe x a b m =
+mapIO a b (AsyncIO ({write, awaitWrite, read, awaitRead} /\ m)) =
-  AsyncPipe
+  AsyncIO $ {write: write <<< a, awaitWrite, read: map b <$> read, awaitRead} /\ mapIO a b m
-    (m x)
+
-    (x -> a -> m WriteResult)
+-- | Modify request / response types
-    (x -> m WriteSignal)
+bindIO :: forall aa ab ba bb m r. Monad m => (ab -> m aa) -> (ba -> m bb) -> AsyncPipe aa ba m r -> AsyncPipe ab bb m r
-    (x -> m (ReadResult b))
+bindIO _ _ (Pure a) = Pure a
-    (x -> m ReadSignal)
+bindIO a b (M m) = M $ bindIO a b <$> m
+bindIO a b (AsyncIO ({write, awaitWrite, read, awaitRead} /\ m)) =
+  AsyncIO $ {write: flip bind write <<< a, awaitWrite, read: traverse b =<< read, awaitRead} /\ bindIO a b m
+
+-- | Remove the `AsyncPipe` wrapper by discarding the IO
+stripIO :: forall a b m r. Monad m => AsyncPipe a b m r -> m r
+stripIO (Pure r) = pure r
+stripIO (M m) = m >>= stripIO
+stripIO (AsyncIO (_ /\ m)) = stripIO m
+
+-- | Execute the `AsyncPipe` monad stack until `AsyncIO` is reached (if any)
+getAsyncIO :: forall a b m r. Monad m => AsyncPipe a b m r -> m (Maybe (AsyncIO a b m r))
+getAsyncIO (AsyncIO a) = pure $ Just a
+getAsyncIO (M m) = m >>= getAsyncIO
+getAsyncIO (Pure _) = pure Nothing
+
+instance MonadTrans (AsyncPipe a b) where
+  lift = M <<< map Pure
+
+instance MFunctor (AsyncPipe a b) where
+  hoist _ (Pure a) = Pure a
+  hoist f (M m) = M $ f $ hoist f <$> m
+  hoist f (AsyncIO ({read, write, awaitWrite, awaitRead} /\ m)) =
+    AsyncIO
+      $ { read: f read
+        , write: f <<< write
+        , awaitWrite: f awaitWrite
+        , awaitRead: f awaitRead
+        }
+        /\ hoist f m
+
+instance Monad m => Functor (AsyncPipe a b m) where
+  map f (Pure r) = Pure $ f r
+  map f (M m) = M $ map f <$> m
+  map f (AsyncIO (io /\ m)) = AsyncIO $ io /\ (f <$> m)
+
+instance Monad m => Apply (AsyncPipe a b m) where
+  apply (Pure f) ma = f <$> ma
+  apply (M mf) ma = M $ (_ <*> ma) <$> mf
+  apply (AsyncIO (io /\ mf)) ma = AsyncIO $ io /\ (mf <*> ma)
+
+instance Monad m => Applicative (AsyncPipe a b m) where
+  pure = Pure
+
+instance Monad m => Bind (AsyncPipe a b m) where
+  bind (Pure a) f = f a
+  bind (M ma) f = M $ (_ >>= f) <$> ma
+  bind (AsyncIO (io /\ m)) f = AsyncIO $ io /\ (m >>= f)
+
+instance Monad m => Monad (AsyncPipe a b m)
+
+instance MonadThrow e m => MonadThrow e (AsyncPipe a b m) where
+  throwError = lift <<< throwError
+
+instance MonadError e m => MonadError e (AsyncPipe a b m) where
+  catchError m f = lift $ catchError (stripIO m) (stripIO <<< f)
+
+instance MonadEffect m => MonadEffect (AsyncPipe a b m) where
+  liftEffect = lift <<< liftEffect
+
+instance MonadAff m => MonadAff (AsyncPipe a b m) where
+  liftAff = lift <<< liftAff
 
 -- | Wraps all fields of an `AsyncPipe` with logging to debug
 -- | behavior and timing.
-debug :: forall x a b m. MonadAff m => String -> AsyncPipe x a b m -> AsyncPipe x a b m
+debug :: forall a b m r. MonadAff m => String -> AsyncPipe (Maybe a) (Maybe b) m r -> AsyncPipe (Maybe a) (Maybe b) m r
-debug c (AsyncPipe init write awaitWrite read awaitRead) =
+debug c m =
   let
-    logL m = liftEffect $ log $ "[" <> c <> "] " <> m
+    logL :: forall m'. MonadEffect m' => _ -> m' Unit
-    logR m = liftEffect $ log $ "[" <> c <> "] " <> fold (Array.replicate 20 " ") <> m
+    logL msg = liftEffect $ log $ "[" <> c <> "] " <> msg
+    logR :: forall m'. MonadEffect m' => _ -> m' Unit
+    logR msg = liftEffect $ log $ "[" <> c <> "] " <> fold (Array.replicate 20 " ") <> msg
 
-    time :: forall a'. m a' -> m (Milliseconds /\ a')
+    time :: forall m' a'. MonadEffect m' => m' a' -> m' (Milliseconds /\ a')
-    time m = do
+    time ma = do
       start <- liftEffect Now.now
-      a <- m
+      a <- ma
       end <- liftEffect Now.now
       pure $ (end `Instant.diff` start) /\ a
-
-    init' = do
-      logL "init >"
-      elapsed /\ x <- time init
-      logL $ "< init " <> "(" <> show (unwrap elapsed) <> "ms)"
-      pure x
-
-    write' x a = do
-      logL "write >"
-      elapsed /\ w <- time $ write x a
-      logL $ "< write " <> show w <> " (" <> show (unwrap elapsed) <> "ms)"
-      pure w
-
-    read' x = do
-      logR "read >"
-      elapsed /\ r <- time $ read x
-      logR $ "< read " <> show (r $> unit) <> " (" <> show (unwrap elapsed) <> "ms)"
-      pure r
-
-    awaitWrite' x = do
-      logL "awaitWrite >"
-      elapsed /\ w <- time $ awaitWrite x
-      logL $ "< awaitWrite " <> show w <> " (" <> show (unwrap elapsed) <> "ms)"
-      pure w
-
-    awaitRead' x = do
-      logR "awaitRead >"
-      elapsed /\ r <- time $ awaitRead x
-      logR $ "< awaitRead " <> show r <> " (" <> show (unwrap elapsed) <> "ms)"
-      pure r
   in
-    AsyncPipe init' write' awaitWrite' read' awaitRead'
+    flip bind (fromMaybe m)
+    $ runMaybeT do
+      (io /\ done') <- MaybeT $ lift $ getAsyncIO m
+      let
+        write a = do
+          logL "write >"
+          elapsed /\ w <- time $ io.write a
+          logL $ "< write " <> show w <> " (" <> show (unwrap elapsed) <> "ms)"
+          pure w
+
+        read = do
+          logR "read >"
+          elapsed /\ r <- time $ io.read
+          logR $ "< read " <> show (map (const unit) <$> r) <> " (" <> show (unwrap elapsed) <> "ms)"
+          pure r
+
+        awaitWrite = do
+          logL "awaitWrite >"
+          elapsed /\ w <- time $ io.awaitWrite
+          logL $ "< awaitWrite " <> show w <> " (" <> show (unwrap elapsed) <> "ms)"
+          pure w
+
+        awaitRead = do
+          logR "awaitRead >"
+          elapsed /\ r <- time $ io.awaitRead
+          logR $ "< awaitRead " <> show r <> " (" <> show (unwrap elapsed) <> "ms)"
+          pure r
+
+        done = do
+          logL "done >"
+          elapsed /\ r <- time done'
+          logL $ "< done (" <> show (unwrap elapsed) <> "ms)"
+          pure r
+      pure $ AsyncIO $ {write, read, awaitWrite, awaitRead} /\ done
 
 -- | Convert an `AsyncPipe` to a regular `Pipe`.
 -- |
@@ -188,43 +267,47 @@ debug c (AsyncPipe init write awaitWrite read awaitRead) =
 -- | * `read` will pass chunks to `parse` as fast as `parse` allows
 -- | * `parse` will parse chunks and yield them to `encode` as soon as they're ready
 -- | * `encode` will encode chunks and yield them to `write` as soon as they're ready
-sync :: forall x a b f p e m. MonadError e m => Alternative p => Parallel p m => MonadFork f m => MonadAff m => AsyncPipe x (Maybe a) (Maybe b) m -> Pipe (Maybe a) (Maybe b) m Unit
+sync :: forall a b f p e m r. MonadError e m => Alternative p => Parallel p m => MonadFork f m => MonadAff m => AsyncPipe (Maybe a) (Maybe b) m r -> Pipe (Maybe a) (Maybe b) m r
-sync (AsyncPipe init write awaitWrite read awaitRead) =
+sync m =
   let
-    liftPipe :: forall r. (Proxy _ _ _ _ m) r -> ExceptT (Step _ _) (Proxy _ _ _ _ m) r
+    liftPipe :: forall r'. (Proxy _ _ _ _ m) r' -> ExceptT (Step _ _) (Proxy _ _ _ _ m) r'
     liftPipe = lift
 
-    liftM :: forall r. m r -> ExceptT (Step _ _) (Proxy _ _ _ _ m) r
+    liftM :: forall r'. m r' -> ExceptT (Step _ _) (Proxy _ _ _ _ m) r'
     liftM = liftPipe <<< lift
+  in
+  lift (getAsyncIO m) >>=
+    case _ of
+      Nothing -> lift $ stripIO m
+      Just ({write, awaitWrite, read, awaitRead} /\ done) ->
+         let
+           awaitRW onR onW =
+             liftM (parOneOf [Right <$> awaitWrite, Left <$> awaitRead])
+             >>= either (const onR) onW
 
-    continue a = throwError (Loop a)
+           wSignal WriteSignalOk = WriteAgain
-    break = throwError (Done unit)
+           wSignal WriteSignalEnded = WriteEnded
 
-    awaitRW x = parOneOf [Right <$> awaitWrite x, Left <$> awaitRead x]
+           tailRecEarly f a = tailRecM (map (either identity identity) <<< runExceptT <<< f) a
+           continue a = throwError (Loop a)
+           break = (Done <$> liftM (stripIO done)) >>= throwError
+         in do
+           flip tailRecEarly WriteAgain \writable -> do
+             rb <- liftM read
+             case rb of
+               ReadWouldBlock
+                 | writable == WriteEnded -> liftM awaitRead *> continue writable
+                 | writable == WriteNeedsDrain -> awaitRW (continue writable) (continue <<< wSignal)
+                 | otherwise -> pure unit
+               ReadOk (Just b) -> liftPipe (yield $ Just b) *> continue writable
+               ReadOk Nothing -> liftPipe (yield Nothing) *> break
 
-    wSignal WriteSignalOk = WriteAgain
+             when (writable /= WriteAgain) $ continue writable
-    wSignal WriteSignalEnded = WriteEnded
-  in do
-    x <- lift init
-    flip tailRecM WriteAgain
-      \w ->
-      map (either identity identity)
-      $ runExceptT do
-          rb <- liftM $ read x
-          case rb of
-            ReadWouldBlock
-              | w == WriteEnded -> liftM (awaitRead x) *> continue w
-              | w == WriteNeedsDrain -> liftM (awaitRW x) >>= either (const $ continue w) (continue <<< wSignal)
-              | otherwise -> pure unit
-            ReadOk (Just b) -> liftPipe (yield $ Just b) *> continue w
-            ReadOk Nothing -> liftPipe (yield Nothing) *> break
 
-          when (w /= WriteAgain) $ continue w
+             a <- liftPipe await
-
+             writable' <- liftM $ write a
-          a <- liftPipe await
+             when (isNothing a) $ continue WriteEnded
-          w' <- liftM $ write x a
+             pure $ Loop writable'
-          when (isNothing a) $ continue WriteEnded
-          pure $ Loop w'
 
 -- | Implementation of `(>-/->)`
 -- |
@@ -238,44 +321,48 @@ sync (AsyncPipe init write awaitWrite read awaitRead) =
 -- |
 -- | If the consuming half fails, the error is caught, the producing half is killed, and the error is rethrown.
 pipeAsync
-  :: forall f m x a b
+  :: forall e f m a b
    . MonadRec m
   => MonadAff m
-  => MonadBracket Error f m
+  => MonadBracket e f m
   => Producer (Maybe a) m Unit
-  -> AsyncPipe x (Maybe a) (Maybe b) m
+  -> AsyncPipe (Maybe a) (Maybe b) m Unit
   -> Producer (Maybe b) m Unit
-pipeAsync prod (AsyncPipe init write awaitWrite read awaitRead) =
+pipeAsync prod m =
-  do
+  lift (getAsyncIO m)
-    errST :: STRef _ (Maybe Error) <- lift $ liftEffect $ liftST $ ST.Ref.new Nothing
+    >>= case _ of
-    killST :: STRef _ Boolean <- lift $ liftEffect $ liftST $ ST.Ref.new false
+          Nothing -> pure unit
+          Just ({write, read, awaitWrite, awaitRead} /\ done) -> do
+            errST :: STRef _ (Maybe e) <- lift $ liftEffect $ liftST $ ST.Ref.new Nothing
+            killST :: STRef _ Boolean <- lift $ liftEffect $ liftST $ ST.Ref.new false
 
-    let
+            let
-      killThread = void $ liftEffect $ liftST $ ST.Ref.write true killST
+              killThread = void $ liftEffect $ liftST $ ST.Ref.write true killST
-      threadKilled = liftEffect $ liftST $ ST.Ref.read killST
+              threadKilled = liftEffect $ liftST $ ST.Ref.read killST
-      putThreadError = void <<< liftEffect <<< liftST <<< flip ST.Ref.write errST <<< Just
+              putThreadError = void <<< liftEffect <<< liftST <<< flip ST.Ref.write errST <<< Just
-      getThreadError = liftEffect $ liftST $ ST.Ref.read errST
+              getThreadError = liftEffect $ liftST $ ST.Ref.read errST
 
-      rx x a = do
+              rx a = do
-        killed <- threadKilled
+                killed <- threadKilled
-        guard $ not killed
+                guard $ not killed
-        w <- lift $ write x a
+                w <- lift $ write a
-        case w of
+                case w of
-          WriteNeedsDrain -> lift $ void $ awaitWrite x
+                  WriteNeedsDrain -> lift $ void awaitWrite
-          WriteEnded -> empty
+                  WriteEnded -> empty
-          WriteAgain -> pure unit
+                  WriteAgain -> pure unit
 
-      spawn = lift <<< fork <<< flip catchError putThreadError
+              spawn = lift <<< fork <<< flip catchError putThreadError
 
-    x <- lift init
+            _thread <- spawn $ void $ runMaybeT $ Collect.foreach rx (hoist lift prod)
-    _thread <- spawn $ void $ runMaybeT $ Collect.foreach (rx x) (hoist lift prod)
 
-    forever do
+            flip tailRecM unit $ const do
-      getThreadError >>= traverse_ throwError
+              getThreadError >>= traverse_ throwError
-      rb <- lift $ read x
+              rb <- lift read
-      case rb of
+              case rb of
-        ReadOk (Just b) -> yield $ Just b
+                ReadOk (Just b) -> yield (Just b) $> Loop unit
-        ReadOk Nothing -> killThread *> yield Nothing
+                ReadOk Nothing -> killThread *> yield Nothing $> Done unit
-        ReadWouldBlock -> void $ lift (awaitRead x)
+                ReadWouldBlock -> void (lift awaitRead) $> Loop unit
+
+            lift $ stripIO done
 
 infixl 7 pipeAsync as >-/->

src/Pipes.Node.Stream.purs

@@ -5,8 +5,6 @@ import Prelude hiding (join)
 import Control.Monad.Error.Class (class MonadThrow, throwError)
 import Control.Monad.Rec.Class (class MonadRec, Step(..), tailRecM)
 import Control.Monad.ST.Class (liftST)
-import Control.Monad.ST.Global (Global)
-import Control.Monad.ST.Ref (STRef)
 import Control.Monad.ST.Ref as ST.Ref
 import Control.Monad.ST.Ref as STRef
 import Control.Monad.Trans.Class (lift)
@@ -15,9 +13,9 @@ import Data.Traversable (for_, traverse_)
 import Data.Tuple.Nested ((/\))
 import Effect (Effect)
 import Effect.Aff.Class (class MonadAff, liftAff)
-import Effect.Class (class MonadEffect, liftEffect)
+import Effect.Class (liftEffect)
 import Effect.Exception (Error)
-import Node.Stream.Object (WriteResult(..), maybeReadResult)
+import Node.Stream.Object (ReadResult(..), WriteResult(..))
 import Node.Stream.Object as O
 import Pipes (await, yield)
 import Pipes (for) as P
@@ -90,78 +88,60 @@ fromWritable w = do
 
   tailRecM go unit
 
-newtype TransformContext a b =
+fromTransformEffect
-  TransformContext
+  :: forall a b m
-    { stream :: O.Transform a b
+   . MonadThrow Error m
-    , removeErrorListener :: Effect Unit
+  => MonadAff m
-    , errorST :: STRef Global (Maybe Error)
+  => Effect (O.Transform a b)
-    }
+  -> AsyncPipe (Maybe a) (Maybe b) m Unit
-
+fromTransformEffect = fromTransform <=< liftEffect
-transformCleanup :: forall m a b. MonadEffect m => TransformContext a b -> m Unit
-transformCleanup (TransformContext {removeErrorListener}) = do
-  liftEffect removeErrorListener
-
-transformStream :: forall a b. TransformContext a b -> O.Transform a b
-transformStream (TransformContext {stream}) = stream
-
-transformRethrow :: forall m a b. MonadThrow Error m => MonadEffect m => TransformContext a b -> m Unit
-transformRethrow (TransformContext {errorST}) = traverse_ throwError =<< liftEffect (liftST $ ST.Ref.read errorST)
 
 -- | Convert a `Transform` stream to an `AsyncPipe`.
 fromTransform
   :: forall a b m
    . MonadThrow Error m
   => MonadAff m
-  => Effect (O.Transform a b)
+  => O.Transform a b
-  -> AsyncPipe (TransformContext a b) (Maybe a) (Maybe b) m
+  -> AsyncPipe (Maybe a) (Maybe b) m Unit
-fromTransform t =
+fromTransform stream = do
-  let
+    { error: errorST, cancel: removeErrorListener } <- liftEffect $ O.withErrorST stream
-    init = do
+    let
-      stream <- liftEffect t
+      rethrow = traverse_ throwError =<< liftEffect (liftST $ ST.Ref.read errorST)
-      { error: errorST, cancel: removeErrorListener } <- liftEffect $ O.withErrorST stream
+      cleanup = liftEffect removeErrorListener
-      pure $ TransformContext {errorST, removeErrorListener, stream}
+
-    write x Nothing = do
+      writeSignal =
-      let s = transformStream x
+        liftEffect (O.isWritableEnded stream)
-      liftEffect $ O.end s
+        <#> if _ then AsyncPipe.WriteSignalEnded else AsyncPipe.WriteSignalOk
-      pure AsyncPipe.WriteEnded
+
-    write x (Just a) = do
+      readSignal =
-      transformRethrow x
+        liftEffect (O.isReadableEnded stream)
-      let s = transformStream x
+        <#> if _ then AsyncPipe.ReadSignalEnded else AsyncPipe.ReadSignalOk
-      w <- liftEffect $ O.write s a
+
-      pure $ case w of
+      writeResult WriteOk = AsyncPipe.WriteAgain
-        WriteOk -> AsyncPipe.WriteAgain
+      writeResult WriteWouldBlock = AsyncPipe.WriteNeedsDrain
-        WriteWouldBlock -> AsyncPipe.WriteNeedsDrain
+
-    awaitWrite x = do
+      readResult (ReadJust a) = AsyncPipe.ReadOk (Just a)
-      transformRethrow x
+      readResult ReadWouldBlock = AsyncPipe.ReadWouldBlock
-      let s = transformStream x
+
-      liftAff $ O.awaitWritableOrClosed s
+      awaitWritable = liftAff $ O.awaitWritableOrClosed stream
-      ended <- liftEffect $ O.isWritableEnded s
+      awaitReadable = liftAff $ O.awaitReadableOrClosed stream
-      if ended then
+
-        pure $ AsyncPipe.WriteSignalEnded
+      awaitWrite = rethrow *> awaitWritable *> writeSignal
-      else do
+      awaitRead = rethrow *> awaitReadable *> readSignal
-        liftAff $ O.awaitWritableOrClosed s
+
-        pure $ AsyncPipe.WriteSignalOk
+      whenReadNotEnded m =
-    read x =
+        liftEffect (O.isReadableEnded stream)
-      do
+          >>= if _ then pure $ AsyncPipe.ReadOk Nothing else m
-        transformRethrow x
+
-        let s = transformStream x
+      readNow = readResult <$> liftEffect (O.read stream)
-        readEnded <- liftEffect $ O.isReadableEnded s
+      writeNow a = writeResult <$> liftEffect (O.write stream a)
-        if readEnded then do
+
-          transformCleanup x
+      read = rethrow *> whenReadNotEnded readNow
-          pure $ AsyncPipe.ReadOk Nothing
+
-        else
+      write Nothing = liftEffect (O.end stream) $> AsyncPipe.WriteEnded
-          maybe AsyncPipe.ReadWouldBlock (AsyncPipe.ReadOk <<< Just) <$> maybeReadResult <$> liftEffect (O.read s)
+      write (Just a) = rethrow *> writeNow a
-    awaitRead x = do
+
-      transformRethrow x
+    AsyncIO ({write, awaitWrite, read, awaitRead} /\ cleanup)
-      let s = transformStream x
-      ended <- liftEffect $ O.isReadableEnded s
-      if ended then
-        pure $ AsyncPipe.ReadSignalEnded
-      else do
-        liftAff $ O.awaitReadableOrClosed s
-        pure $ AsyncPipe.ReadSignalOk
-  in
-    AsyncPipe init write awaitWrite read awaitRead
 
 -- | Given a `Producer` of values, wrap them in `Just`.
 -- |

src/Pipes.Node.Zlib.purs

@@ -13,33 +13,31 @@ import Node.Stream.Object as O
 import Node.Zlib as Zlib
 import Node.Zlib.Types (ZlibStream)
 import Pipes.Async (AsyncPipe)
-import Pipes.Node.Stream (TransformContext, fromTransform)
+import Pipes.Node.Stream (fromTransform)
 
-type X = TransformContext Buffer Buffer
+fromZlib :: forall r m. MonadAff m => MonadThrow Error m => Effect (ZlibStream r) -> AsyncPipe (Maybe Buffer) (Maybe Buffer) m Unit
-
-fromZlib :: forall r m. MonadAff m => MonadThrow Error m => Effect (ZlibStream r) -> AsyncPipe X (Maybe Buffer) (Maybe Buffer) m
 fromZlib z =
-  fromTransform do
+  do
     raw <- liftEffect $ Zlib.toDuplex <$> z
-    pure $ O.unsafeCoerceTransform raw
+    fromTransform $ O.unsafeCoerceTransform raw
 
-gzip :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe X (Maybe Buffer) (Maybe Buffer) m
+gzip :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe (Maybe Buffer) (Maybe Buffer) m Unit
 gzip = fromZlib Zlib.createGzip
 
-gunzip :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe X (Maybe Buffer) (Maybe Buffer) m
+gunzip :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe (Maybe Buffer) (Maybe Buffer) m Unit
 gunzip = fromZlib Zlib.createGunzip
 
-unzip :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe X (Maybe Buffer) (Maybe Buffer) m
+unzip :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe (Maybe Buffer) (Maybe Buffer) m Unit
 unzip = fromZlib Zlib.createUnzip
 
-inflate :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe X (Maybe Buffer) (Maybe Buffer) m
+inflate :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe (Maybe Buffer) (Maybe Buffer) m Unit
 inflate = fromZlib Zlib.createInflate
 
-deflate :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe X (Maybe Buffer) (Maybe Buffer) m
+deflate :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe (Maybe Buffer) (Maybe Buffer) m Unit
 deflate = fromZlib Zlib.createDeflate
 
-brotliCompress :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe X (Maybe Buffer) (Maybe Buffer) m
+brotliCompress :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe (Maybe Buffer) (Maybe Buffer) m Unit
 brotliCompress = fromZlib Zlib.createBrotliCompress
 
-brotliDecompress :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe X (Maybe Buffer) (Maybe Buffer) m
+brotliDecompress :: forall m. MonadAff m => MonadThrow Error m => AsyncPipe (Maybe Buffer) (Maybe Buffer) m Unit
 brotliDecompress = fromZlib Zlib.createBrotliDecompress

src/Pipes.Util.purs

@@ -15,9 +15,12 @@ import Data.Either (hush)
 import Data.HashSet as HashSet
 import Data.Hashable (class Hashable, hash)
 import Data.List.NonEmpty (NonEmptyList)
-import Data.Maybe (Maybe(..), fromMaybe)
+import Data.Maybe (Maybe(..), fromMaybe, maybe)
+import Data.Traversable (traverse_)
 import Data.Tuple.Nested (type (/\), (/\))
 import Effect.Class (class MonadEffect, liftEffect)
+import Node.Buffer (Buffer)
+import Node.Buffer as Buffer
 import Pipes (await, yield)
 import Pipes as Pipes
 import Pipes.Core (Pipe, Producer)
@@ -96,6 +99,30 @@ chunked size = do
 
   yield Nothing
 
+-- | Buffers input to the given size before passing to subsequent pipes
+buffered :: forall m. MonadEffect m => Int -> Pipe (Maybe Buffer) (Maybe Buffer) m Unit
+buffered size = do
+  chunkST :: STRef _ (Maybe Buffer) <- liftEffect $ liftST $ STRef.new Nothing
+
+  let
+    chunkClear = liftEffect $ liftST $ STRef.write Nothing chunkST
+    chunkPeek = liftEffect $ liftST $ STRef.read chunkST
+    chunkLen = maybe (pure 0) (liftEffect <<< Buffer.size) =<< chunkPeek
+    chunkPut b = liftEffect do
+      new <- liftST (STRef.read chunkST) >>= maybe (pure b) (\a -> Buffer.concat [a, b])
+      void $ liftST $ STRef.write (Just new) chunkST
+      pure new
+
+  Rec.whileJust $ runMaybeT do
+    a <- MaybeT await
+    buf <- chunkPut a
+    len <- lift chunkLen
+    when (len > size) $ chunkClear *> lift (yield $ Just buf)
+
+  len <- chunkLen
+  chunkPeek >>= traverse_ (when (len > 0) <<< yield <<< Just)
+  yield Nothing
+
 -- | Equivalent of unix `uniq`, filtering out duplicate values passed to it.
 -- |
 -- | Uses a `HashSet` of hashes of `a`; for `n` elements `awaited`, this pipe
@@ -149,5 +176,3 @@ invoke m a =
         Pure _ -> pure Exited
   in
     go (IDidNotAwait m)
-
-

test/Test/Pipes.Node.Stream.purs

@@ -150,8 +150,8 @@ spec =
               cbor :: Buffer <- Pipe.Collect.toBuffer
                 $ Pipe.FS.read a
                   >-> Pipe.Node.inEOS (Pipe.Buffer.toString UTF8)
-                  >-/-> Pipe.Node.fromTransform csvDecode
+                  >-/-> Pipe.Node.fromTransformEffect csvDecode
-                  >-/-> Pipe.Node.fromTransform cborEncode
+                  >-/-> Pipe.Node.fromTransformEffect cborEncode
                   >-> Pipe.Node.unEOS
               f :: Array Foreign <- liftEffect $ cborDecodeSync cbor
               ppl <- traverse (liftEither <<< lmap (error <<< show) <<< runExcept <<< readImpl) f
@@ -163,8 +163,8 @@ spec =
               cbor :: Buffer <- Pipe.Collect.toBuffer
                 $ Pipe.FS.read a
                   >-> Pipe.Node.inEOS (Pipe.Buffer.toString UTF8)
-                  >-> sync (Pipe.Node.fromTransform csvDecode)
+                  >-> sync (Pipe.Node.fromTransformEffect csvDecode)
-                  >-> sync (Pipe.Node.fromTransform cborEncode)
+                  >-> sync (Pipe.Node.fromTransformEffect cborEncode)
                   >-> Pipe.Node.unEOS
               f :: Array Foreign <- liftEffect $ cborDecodeSync cbor
               ppl <- traverse (liftEither <<< lmap (error <<< show) <<< runExcept <<< readImpl) f
@@ -188,7 +188,7 @@ spec =
               Pipe.Collect.toMonoid
               $ Pipe.FS.read a
                 >-/-> Pipe.Zlib.gzip
-                >-/-> Pipe.Node.fromTransform slowTransform
+                >-/-> Pipe.Node.fromTransformEffect slowTransform
                 >-/-> Pipe.Zlib.gunzip
                 >-> Pipe.Node.unEOS
                 >-> Pipe.Buffer.toString UTF8
@@ -201,7 +201,7 @@ spec =
               Pipe.Collect.toMonoid
               $ Pipe.FS.read a
                 >-> sync Pipe.Zlib.gzip
-                >-> sync (Pipe.Node.fromTransform slowTransform)
+                >-> sync (Pipe.Node.fromTransformEffect slowTransform)
                 >-> sync Pipe.Zlib.gunzip
                 >-> Pipe.Node.unEOS
                 >-> Pipe.Buffer.toString UTF8
@@ -210,10 +210,19 @@ spec =
       around tmpFile $ it "file >-> discardTransform" \(p :: String) -> do
         liftEffect $ FS.writeTextFile UTF8 p "foo"
         r <- reader p
-        out :: List.List Int <- Pipe.toListM $ r >-/-> Pipe.Node.fromTransform discardTransform >-> Pipe.Node.unEOS
+        out :: List.List Int <-
+          Pipe.toListM
+            $ r
+                >-/-> Pipe.Node.fromTransformEffect discardTransform
+                >-> Pipe.Node.unEOS
         out `shouldEqual` List.Nil
       around tmpFile $ it "file >-> charsTransform" \(p :: String) -> do
         liftEffect $ FS.writeTextFile UTF8 p "foo bar"
         r <- reader p
-        out :: List.List String <- Pipe.toListM $ r >-> Pipe.Node.inEOS (Pipe.Buffer.toString UTF8) >-/-> Pipe.Node.fromTransform charsTransform >-> Pipe.Node.unEOS
+        out :: List.List String <-
+          Pipe.toListM $
+            r
+            >-> Pipe.Node.inEOS (Pipe.Buffer.toString UTF8)
+            >-/-> Pipe.Node.fromTransformEffect charsTransform
+            >-> Pipe.Node.unEOS
         out `shouldEqual` List.fromFoldable [ "f", "o", "o", " ", "b", "a", "r" ]