🎉

vendor/psy/psysh/src/Readline/Hoa/StreamBufferable.php

@@ -0,0 +1,73 @@
+<?php
+
+/**
+ * Hoa
+ *
+ *
+ * @license
+ *
+ * New BSD License
+ *
+ * Copyright © 2007-2017, Hoa community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the Hoa nor the names of its contributors may be
+ *       used to endorse or promote products derived from this software without
+ *       specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace Psy\Readline\Hoa;
+
+/**
+ * Interface \Hoa\Stream\IStream\Bufferable.
+ *
+ * Interface for bufferable streams. It's complementary to native buffer support
+ * of Hoa\Stream (please, see *StreamBuffer*() methods). Classes implementing
+ * this interface are able to create nested buffers, flush them etc.
+ */
+interface StreamBufferable extends IStream
+{
+    /**
+     * Start a new buffer.
+     * The callable acts like a light filter.
+     */
+    public function newBuffer($callable = null, int $size = null): int;
+
+    /**
+     * Flush the buffer.
+     */
+    public function flush();
+
+    /**
+     * Delete buffer.
+     */
+    public function deleteBuffer(): bool;
+
+    /**
+     * Get bufffer level.
+     */
+    public function getBufferLevel(): int;
+
+    /**
+     * Get buffer size.
+     */
+    public function getBufferSize(): int;
+}