>>> import qualified Streamly.FileSystem.Handle as Handle

Read and write byte streams and array streams to and from file handles (Handle).

The TextEncoding, NewLineMode, and Buffering options of the underlying GHC Handle are ignored by these APIs. Please use Streamly.Unicode.Stream module for encoding and decoding a byte stream, use stream splitting operations in Streamly.Data.Stream to create a stream of lines or to split the input stream on any other type of boundaries.

To set the read or write start position use hSeek on the Handle, the before combinator may be used to do that on a streaming combinator. To restrict the length of read or write use the stream trimming operations like take.

Note that a Handle is inherently stateful, therefore, we cannot use these APIs from multiple threads without serialization; reading or writing in one thread would affect the file position for other threads.

For additional, experimental APIs take a look at Streamly.Internal.FileSystem.Handle module.

Read or write a single buffer.

Read or write a stream of data to or from a file or device sequentially.

Read requests to the IO device are performed in chunks limited to a maximum size of defaultChunkSize. Note that the size of the actual chunks in the resulting stream may be less than the defaultChunkSize but it can never exceed it. If the whole stream is not consumed, it is possible that we may have read slightly more from the IO device than what the consumer needed.

Unless specified otherwise in the API, writes are collected into chunks of defaultChunkSize before they are written to the IO device.

TextEncoding, NewLineMode, and Buffering options of the underlying handle are ignored. The read occurs from the current seek position of the file handle. The stream ends as soon as EOF is encountered.

TextEncoding, NewLineMode, and Buffering options of the underlying handle are ignored. The write occurs from the current seek position of the file handle. The write behavior depends on the IOMode of the handle.