f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
142 lines
6.0 KiB
XML
142 lines
6.0 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="PoolByteArray" version="3.4">
|
|
<brief_description>
|
|
A pooled [Array] of bytes.
|
|
</brief_description>
|
|
<description>
|
|
An [Array] specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory.
|
|
[b]Note:[/b] This type is passed by value and not by reference.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="PoolByteArray">
|
|
<return type="PoolByteArray" />
|
|
<argument index="0" name="from" type="Array" />
|
|
<description>
|
|
Constructs a new [PoolByteArray]. Optionally, you can pass in a generic [Array] that will be converted.
|
|
</description>
|
|
</method>
|
|
<method name="append">
|
|
<argument index="0" name="byte" type="int" />
|
|
<description>
|
|
Appends an element at the end of the array (alias of [method push_back]).
|
|
</description>
|
|
</method>
|
|
<method name="append_array">
|
|
<argument index="0" name="array" type="PoolByteArray" />
|
|
<description>
|
|
Appends a [PoolByteArray] at the end of this array.
|
|
</description>
|
|
</method>
|
|
<method name="compress">
|
|
<return type="PoolByteArray" />
|
|
<argument index="0" name="compression_mode" type="int" default="0" />
|
|
<description>
|
|
Returns a new [PoolByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants.
|
|
</description>
|
|
</method>
|
|
<method name="decompress">
|
|
<return type="PoolByteArray" />
|
|
<argument index="0" name="buffer_size" type="int" />
|
|
<argument index="1" name="compression_mode" type="int" default="0" />
|
|
<description>
|
|
Returns a new [PoolByteArray] with the data decompressed. Set [code]buffer_size[/code] to the size of the uncompressed data. Set the compression mode using one of [enum File.CompressionMode]'s constants.
|
|
</description>
|
|
</method>
|
|
<method name="decompress_dynamic">
|
|
<return type="PoolByteArray" />
|
|
<argument index="0" name="max_output_size" type="int" />
|
|
<argument index="1" name="compression_mode" type="int" default="0" />
|
|
<description>
|
|
Returns a new [PoolByteArray] with the data decompressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. [b]This method only accepts gzip and deflate compression modes.[/b]
|
|
This method is potentially slower than [code]decompress[/code], as it may have to re-allocate it's output buffer multiple times while decompressing, where as [code]decompress[/code] knows it's output buffer size from the begining.
|
|
|
|
GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via [code]max_output_size[/code]. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that ammount in bytes, then an error will be returned.
|
|
</description>
|
|
</method>
|
|
<method name="empty">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if the array is empty.
|
|
</description>
|
|
</method>
|
|
<method name="get_string_from_ascii">
|
|
<return type="String" />
|
|
<description>
|
|
Returns a copy of the array's contents as [String]. Fast alternative to [method get_string_from_utf8] if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use [method get_string_from_utf8].
|
|
</description>
|
|
</method>
|
|
<method name="get_string_from_utf8">
|
|
<return type="String" />
|
|
<description>
|
|
Returns a copy of the array's contents as [String]. Slower than [method get_string_from_ascii] but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred.
|
|
</description>
|
|
</method>
|
|
<method name="hex_encode">
|
|
<return type="String" />
|
|
<description>
|
|
Returns a hexadecimal representation of this array as a [String].
|
|
[codeblock]
|
|
var array = PoolByteArray([11, 46, 255])
|
|
print(array.hex_encode()) # Prints: 0b2eff
|
|
[/codeblock]
|
|
</description>
|
|
</method>
|
|
<method name="insert">
|
|
<return type="int" />
|
|
<argument index="0" name="idx" type="int" />
|
|
<argument index="1" name="byte" type="int" />
|
|
<description>
|
|
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
|
|
</description>
|
|
</method>
|
|
<method name="invert">
|
|
<description>
|
|
Reverses the order of the elements in the array.
|
|
</description>
|
|
</method>
|
|
<method name="push_back">
|
|
<argument index="0" name="byte" type="int" />
|
|
<description>
|
|
Appends an element at the end of the array.
|
|
</description>
|
|
</method>
|
|
<method name="remove">
|
|
<argument index="0" name="idx" type="int" />
|
|
<description>
|
|
Removes an element from the array by index.
|
|
</description>
|
|
</method>
|
|
<method name="resize">
|
|
<argument index="0" name="idx" type="int" />
|
|
<description>
|
|
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
|
|
</description>
|
|
</method>
|
|
<method name="set">
|
|
<argument index="0" name="idx" type="int" />
|
|
<argument index="1" name="byte" type="int" />
|
|
<description>
|
|
Changes the byte at the given index.
|
|
</description>
|
|
</method>
|
|
<method name="size">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the size of the array.
|
|
</description>
|
|
</method>
|
|
<method name="subarray">
|
|
<return type="PoolByteArray" />
|
|
<argument index="0" name="from" type="int" />
|
|
<argument index="1" name="to" type="int" />
|
|
<description>
|
|
Returns the slice of the [PoolByteArray] between indices (inclusive) as a new [PoolByteArray]. Any negative index is considered to be from the end of the array.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|