Module hilbish.sink

Introduction#

A sink is a writable and readable interface to a stream of data. Hilbish uses sinks for command output and input streams, and they can be used in many places like in hilbish.run with the streams parameter.

You will most commonly encounter sinks rather than create them directly: a Commander's callback receives sinks.out, sinks.err, and sinks.input (see the commander module doc), and hilbish.run()'s streams table accepts sinks for out, err, and input to redirect a command's I/O.

fs.pipe() creates a connected pair of sinks directly, useful for piping data between commands manually.

local fs = require 'fs'
local pr, pw = fs.pipe()

pw:writeln 'hello from the write end'
print(pr:readAll()) -- -> hello from the write end

Functions#

Types#

Sink#

A sink is a writable and readable interface to a stream of data. Hilbish uses sinks for command output and input streams.

Methods#

sink.autoFlush#

hilbish.sink:autoFlush(auto)

Since: 2.2.0

Sets whether the sink automatically flushes after every write.

Parameters#

sink.flush#

hilbish.sink:flush()

Since: 2.2.0

Flushes all buffered data, writing it to the underlying destination.

sink.read#

hilbish.sink:read() -> string

Since: 2.2.0

Reads a single line of input from the sink.

Returns#

sink.readAll#

hilbish.sink:readAll() -> string

Since: 2.2.0

Reads all buffered input from the sink.

Returns#

sink.write#

hilbish.sink:write(str)

Since: 2.1.0

Writes a string to the sink.

Parameters#

sink.writeln#

hilbish.sink:writeln(str)

Since: 2.1.0

Writes a string to the sink followed by a newline.

Parameters#