0
0
mirror of https://github.com/pmmp/ext-encoding.git synced 2025-10-06 18:59:57 +00:00
Files
ext-encoding/stubs/ByteBufferWriter.stub.php
2025-09-06 22:39:12 +01:00

91 lines
2.7 KiB
PHP

<?php
/**
* @generate-class-entries
* @generate-legacy-arginfo 80100
*/
namespace pmmp\encoding;
/**
* @strict-properties
*/
final class ByteBufferWriter{
/** @genstubs-expose-comment-block
* Constructs a new ByteBufferWriter.
* The provided string will be written at the start of the buffer as if readByteArray() was called.
*/
public function __construct(string $prefix = ""){}
/** @genstubs-expose-comment-block
* Returns a string containing the written bytes.
* Reserved memory is not included.
*/
public function getData() : string{}
/** @genstubs-expose-comment-block
* 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{}
/** @genstubs-expose-comment-block
* Returns the current internal write offset (the position
* from which the next write operation will start).
*/
public function getOffset() : int{}
/** @genstubs-expose-comment-block
* 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 setOffset(int $offset) : void{}
/** @genstubs-expose-comment-block
* Returns the total number of bytes written.
* This will always be less than or equal to the reserved length.
*/
public function getUsedLength() : int{}
/** @genstubs-expose-comment-block
* Returns the number of bytes reserved by the ByteBuffer.
* This value may be larger than the number of written bytes, as
* some memory may be preallocated to avoid reallocations.
*/
public function getReservedLength() : int{}
/** @genstubs-expose-comment-block
* 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{}
/** @genstubs-expose-comment-block
* Truncates the internal buffer to only the written part,
* discarding any unused reserved memory.
*/
public function trim() : void{}
/** @genstubs-expose-comment-block
* 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{}
}