mirror of
https://github.com/pmmp/ext-encoding.git
synced 2024-11-14 09:27:19 +00:00
d0e71a30aa
this isn't the final form, but these statics already turned out to be handy for the tests, and they'll probably be good for attributes and other stuff like it.
110 lines
3.0 KiB
PHP
110 lines
3.0 KiB
PHP
<?php
|
|
|
|
/** @generate-class-entries */
|
|
|
|
namespace pmmp\encoding;
|
|
|
|
/**
|
|
* @strict-properties
|
|
*/
|
|
final class ByteBuffer{
|
|
/**
|
|
* Constructs a new ByteBuffer.
|
|
* The read offset will be initialized to 0.
|
|
* The write offset will be initialized to the length of the given buffer.
|
|
*/
|
|
public function __construct(string $buffer = ""){}
|
|
|
|
/**
|
|
* Returns a string containing the initialized bytes.
|
|
* Reserved memory is not included.
|
|
*/
|
|
public function toString() : string{}
|
|
|
|
/**
|
|
* Reads $length raw bytes from the buffer at the current offset.
|
|
* The internal offset will be updated by this operation.
|
|
*/
|
|
public function readByteArray(int $length) : string{}
|
|
|
|
/**
|
|
* Writes the given bytes to the buffer at the current offset.
|
|
* The internal offset will be updated by this operation.
|
|
*
|
|
* If the current buffer size is not big enough to add the given
|
|
* bytes, the buffer will be resized to either 2x its current size,
|
|
* or the actual size of the result, whichever is larger. This
|
|
* ensures the lowest number of reallocations.
|
|
*/
|
|
public function writeByteArray(string $value) : void{}
|
|
|
|
/**
|
|
* Returns the current internal read offset (the position
|
|
* from which the next read operation will start).
|
|
*/
|
|
public function getReadOffset() : int{}
|
|
|
|
/**
|
|
* Returns the current internal write offset (the position
|
|
* from which the next write operation will start).
|
|
*/
|
|
public function getWriteOffset() : int{}
|
|
|
|
/**
|
|
* Sets the internal read offset to the given value.
|
|
* The offset must be within the bounds of the buffer
|
|
* (0 <= offset <= used length).
|
|
*
|
|
* @throws \ValueError if the offset is out of bounds
|
|
*/
|
|
public function setReadOffset(int $offset) : void{}
|
|
|
|
/**
|
|
* Sets the internal write offset to the given value.
|
|
* The offset must be within the bounds of the buffer
|
|
* (0 <= offset <= reserved length).
|
|
*
|
|
* @throws \ValueError if the offset is out of bounds
|
|
*/
|
|
public function setWriteOffset(int $offset) : void{}
|
|
|
|
/**
|
|
* Returns the total number of bytes written or available to read.
|
|
* This will always be less than or equal to the reserved length.
|
|
*/
|
|
public function getUsedLength() : int{}
|
|
|
|
/**
|
|
* Returns the number of bytes reserved by the ByteBuffer.
|
|
* This value may be larger than the number of readable bytes, as
|
|
* some memory may be preallocated to avoid reallocations.
|
|
*/
|
|
public function getReservedLength() : int{}
|
|
|
|
/**
|
|
* Increases buffer capacity to the given value, if the capacity
|
|
* is less than this amount. Useful to avoid extra reallocations
|
|
* during large write operations when the needed capacity of the
|
|
* buffer is known in advance.
|
|
*/
|
|
public function reserve(int $length) : void{}
|
|
|
|
/**
|
|
* Truncates the internal buffer to only the initialized part,
|
|
* discarding any unused reserved memory.
|
|
*/
|
|
public function trim() : void{}
|
|
|
|
/**
|
|
* Clears all data from the buffer. The memory used is retained
|
|
* as reserved memory.
|
|
*/
|
|
public function clear() : void{}
|
|
|
|
public function __serialize() : array{}
|
|
|
|
public function __unserialize(array $data) : void{}
|
|
|
|
public function __debugInfo() : array{}
|
|
}
|