Rework file stream API #46

Activity

1. WyriHaximus

   added

   help wanted

   on Sep 22, 2018
2. WyriHaximus

   added this to the v0.2.0 milestone on Sep 22, 2018
3. clue commented on Oct 28, 2018

   

   clue

   on Oct 28, 2018

   Member

   More actions

   What are your plans for the API, do you have anything in mind?

   I agree that the API surface is much more complex than everything I've ever needed for my (perhaps somewhat simple) use cases. I would welcome to have something like read(string $path): PromiseInterface<string> and readStream(string $path): ReadableStreamInterface<string> more prominently instead of exposing low-level file and directory objects.
4. WyriHaximus commented on Oct 28, 2018

   

   WyriHaximus

   on Oct 28, 2018

   MemberAuthor

   More actions

   I should have work this issue out better as this is really about streaming the contents of a directory. @CharlotteDunois is already working on improving the reading and writing to and from files.

   To simplify that API I'd like to collapse both into read(string $path): Observable using RxPHP. To clarify the read() method is for use cases where you only get a small set of results where readStream() is to be used when the call will yield a lot of results and will cause increased memory usage. Now when using observables we can easily do both.

   For small loads:

   $directoryContents = Promise::fromObservable($filesystem->read(__DIR__)->toArray());

   For large loads:

   $filesystem->read(__DIR__)->subscribe(function (NodeInterface $node) {
      // Do something with $node
   });

   Using observables we can filter out files, directories, or symlinks:

   $filesystem->read(__DIR__)->filter(function (NodeInterface $node) {
       // Filter out everything by files
       return $node instanceof FileInterface;
   })->subscribe(function (NodeInterface $node) {
      // Do something with $node
   });

   Or to go even more advanced filter our all files above 1KB:

   $filesystem->read(__DIR__)->filter(function (NodeInterface $node) {
       return $node instanceof FileInterface;
   })->filter(function (FileInterface $file) {
       // This example is actually more complicated because we have to deal with a promise but this is the basic idea
   	return $file->size() < 1024;
   })->subscribe(function (FileInterface $file) {
      // Do something with $file
   });
6. WyriHaximus commented on Nov 13, 2018

   

   WyriHaximus

   on Nov 13, 2018

   MemberAuthor

   More actions

   @CharlotteDunois sorry for the late response, but go for it, this makes a lot of sense 👍