NovelIO


BinaryChannel

Namespace: NovelFS.NovelIO

Operations on binary channels

Functions and values

Function or valueDescription
close channel
Signature: channel:BChannel -> IO<unit>

An action that closes a binary channel

isEOF channel
Signature: channel:BChannel -> IO<bool>

Determines if the end of the channel has been reached

isEOS channel
Signature: channel:BChannel -> IO<bool>

Determines if the end of the channel has been reached

read channel maxCount
Signature: channel:BChannel -> maxCount:int -> IO<byte []>

An action that reads up to a specified number of bytes from a channel and returns the result as a byte array

readExactly channel count
Signature: channel:BChannel -> count:int -> IO<byte []>

An action that reads exactly count bytes from a channel and throws an exception if the end of the stream is reached

setAbsPosition channel pos
Signature: channel:BChannel -> pos:int64 -> IO<unit>

An action that sets the position of the binary channel to the supplied absolute position

writeBytes channel bytes
Signature: channel:BChannel -> bytes:byte [] -> IO<unit>

An action that writes a supplied array of bytes to the binary channel

Fork me on GitHub