meekframework/stream

MeekFramework Stream Component

![Scrutinizer Build Status][scrutinizer-build-image] ![Scrutinizer Code Quality][scrutinizer-code-quality-image] ![Scrutinizer Code Coverage][scrutinizer-code-coverage-image] , _(*1)

A set of interfaces for working with streams, as well as an in-memory implementation., _(*2)

Installation

With Composer:, _(*3)

composer require meekframework/stream

Usage

Using the interfaces:, _(*4)

// write to stdout...
class CliOutput implements Meek\Stream\Writable
{
    public function write(string $data): int
    {
        // implementation here...
    }
}

// read from stdin...
class CliInput implements Meek\Stream\Readable, Meek\Stream\Seekable
{
    // implement methods from contracts...
}

Using the in-memory Buffer class:, _(*5)

$stream = new Buffer('hello');

$stream->read(2);   // returns 'he'
$stream->getContents(); // returns 'llo'
$stream->write(' world');

$stream->rewind();
$stream->getContents(); // returns 'hello world'

Interfaces

• Duplex
• Lockable
• Readable
• Seekable
• Transform
• Writable

Contributing

See CONTRIBUTING.md., _(*6)

Credits/Authors

License

The MIT License (MIT). Please see LICENSE.md for more information., _(*7)