Abstract handle to directory contents.
May be closed multiple times and will be automatically closed by GC when it goes out of scope.
Constructors
DirStreamdsHandle :: !RawDirStreamdsIsClosed :: !CounterdsFin :: !Weak DirStream
Moduledirectory-ospath-streaming-0.3Haskell2010
System.Directory.OsPath.Streaming.Internal
Synopsis
- data DirStream
- value openDirStream
- value readDirStream
- value readDirStreamFull
- value closeDirStream
- Packagedirectory-ospath-streaming-0.3
- Exports5
- LanguageHaskell2010
- LicenceApache-2.0
- SourceInternal.hs
Returns basename path of the directory entry.
Returns both basename path and full path of a directory entry relative to the passed DirStream root.
For example:
readDirStreamFull =<< openDirStream [osp|.|]
Just ("./bar",Basename {unBasename = "foo"},File Regular)readDirStreamFull =<< openDirStream [osp|foo/|]
Just ("foo/bar",Basename {unBasename = "foo"},File Regular)readDirStreamFull =<< openDirStream [osp|/foo/foo|]
Just ("/foo/foo/bar",Basename {unBasename = "foo"},File Regular)This allows to avoid re-creating the full path on the client side and thus reduce allocations.
Deallocate directory handle. It’s safe to close DirStream multiple times, unlike the underlying OS-specific directory stream handle.