README
¶
Multee, an io.Reader multiplexer
Purpose
This package implements a multiplexer for io.Reader, making it possible to read from a single io.Reader several times concurrently,
without needing to Seek back to the beginning.
Usage
Create a multee-reader from a single io.Reader, and create as many readers as you need:
inputReader := strings.NewReader("Foo")
mr := multee.NewMulteeReader(inputReader)
r1 := mr.NewReader()
r2 := mr.NewReader()
r3 := mr.NewReader()
Now, you can use r1, r2 and r3 as a regular io.ReadCloser.
Each reader must be read in its own go-routine, and they must either be read until EOF or Close() must be called, or the MulteeReader will block.
The returned readers themselves are not concurrency-safe.
See also the code examples.
Testing
Just run poor man's CI, make test.
Contribute
Feel free to contribute, even if it's just to complain! Issues and pull requests are welcome.
See the contributing instructions for help to get started.
Documentation
¶
Overview ¶
Package multee implements a multiplexer for io.Readers, making it possible to read from a single io.Reader several times, without needing to Seek back to the beginning.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrClosed = errors.New("multeeReader already closed")
)
Functions ¶
func NewMulteeReader ¶
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
alt
|
|
|
byteslice
Alternative implementation of the package, using a synchronized byte slice as a buffer.
|
Alternative implementation of the package, using a synchronized byte slice as a buffer. |
|
byteslicechan
Alternative implementation of the package, using channels.
|
Alternative implementation of the package, using channels. |
|
examples
|
|
|
alt-byteslicechan
command
Example code for how to use an alternative implementation of the multee package.
|
Example code for how to use an alternative implementation of the multee package. |
|
huge
command
Example code for how to use the multee package on huge input streams (ie.
|
Example code for how to use the multee package on huge input streams (ie. |
|
simple
command
Example code for how to use the multee package.
|
Example code for how to use the multee package. |