Create fs2.io.file APIs for Node.js
#2478
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mpilquist
reviewed
Jul 19, 2021
| @@ -0,0 +1,36 @@ | |||
| /* | |||
There was a problem hiding this comment.
Can you rename this file to something else? It will conflict with folks using editor quick open features for Stream.scala
There was a problem hiding this comment.
Good point, done. Thanks!
mpilquist
approved these changes
Jul 19, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Picking up from #2453.
This PR introduces a new
PosixFilestypeclass, currently implemented only for Node.js. It is closely modeled on Node.js'sfsmodule but otherwise shouldn't be specific to Node.js at all. I hope future work will implement it for JVM.For the sake of offering some platform-agnostic API, I also introduced a
ReadFilestypeclass which bothFilesandPosixFilesextend. File-reading seems both safe and straightforward enough to do in a platform-agnostic manner. I'd love to see a similarWriteFilestypeclass as well, but it would have to be carefully implemented to get right the semantics of open/create/append/truncate etc.Both new typeclasses are
sealedto give us some room to iterate on these APIs.For testing, I copy-pastad the JVM file suite and re-worked for JS. So, essentially anything we can do on JVM we can do on JS, just with different semantics.
I also slipped in the Unix sockets implementation now that File APIs are available.
The only thing missing is a
Watcherimplementation. We can definitely do this on Node.js as well, but at a first glance seems fairly complicated to implement and I don't want the good stuff here blocked by it. So, I'll finish it off in one more PR.Thanks in advance for feedback and reviews.