Spaces:
Configuration error
Configuration error
File size: 9,704 Bytes
5641073 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
/**
* @author jdiaz5513
*/
import { Int64, Uint64 } from "../types";
import { Message } from "./message";
import { Pointer } from "./pointers";
export declare class Segment implements DataView {
buffer: ArrayBuffer;
/** The number of bytes currently allocated in the segment. */
byteLength: number;
/**
* This value should always be zero. It's only here to satisfy the DataView interface.
*
* In the future the Segment implementation (or a child class) may allow accessing the buffer from a nonzero offset,
* but that adds a lot of extra arithmetic.
*/
byteOffset: number;
readonly [Symbol.toStringTag]: "DataView";
readonly id: number;
readonly message: Message;
private _dv;
constructor(id: number, message: Message, buffer: ArrayBuffer, byteLength?: number);
/**
* Attempt to allocate the requested number of bytes in this segment. If this segment is full this method will return
* a pointer to freshly allocated space in another segment from the same message.
*
* @param {number} byteLength The number of bytes to allocate, will be rounded up to the nearest word.
* @returns {Pointer} A pointer to the newly allocated space.
*/
allocate(byteLength: number): Pointer;
/**
* Quickly copy a word (8 bytes) from `srcSegment` into this one at the given offset.
*
* @param {number} byteOffset The offset to write the word to.
* @param {Segment} srcSegment The segment to copy the word from.
* @param {number} srcByteOffset The offset from the start of `srcSegment` to copy from.
* @returns {void}
*/
copyWord(byteOffset: number, srcSegment: Segment, srcByteOffset: number): void;
/**
* Quickly copy words from `srcSegment` into this one.
*
* @param {number} byteOffset The offset to start copying into.
* @param {Segment} srcSegment The segment to copy from.
* @param {number} srcByteOffset The start offset to copy from.
* @param {number} wordLength The number of words to copy.
* @returns {void}
*/
copyWords(byteOffset: number, srcSegment: Segment, srcByteOffset: number, wordLength: number): void;
/**
* Quickly fill a number of words in the buffer with zeroes.
*
* @param {number} byteOffset The first byte to set to zero.
* @param {number} wordLength The number of words (not bytes!) to zero out.
* @returns {void}
*/
fillZeroWords(byteOffset: number, wordLength: number): void;
/** WARNING: This function is not yet implemented. */
getBigInt64(byteOffset: number, littleEndian?: boolean): bigint;
/** WARNING: This function is not yet implemented. */
getBigUint64(byteOffset: number, littleEndian?: boolean): bigint;
/**
* Get the total number of bytes available in this segment (the size of its underlying buffer).
*
* @returns {number} The total number of bytes this segment can hold.
*/
getCapacity(): number;
/**
* Read a float32 value out of this segment.
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getFloat32(byteOffset: number): number;
/**
* Read a float64 value out of this segment.
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getFloat64(byteOffset: number): number;
/**
* Read an int16 value out of this segment.
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getInt16(byteOffset: number): number;
/**
* Read an int32 value out of this segment.
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getInt32(byteOffset: number): number;
/**
* Read an int64 value out of this segment.
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getInt64(byteOffset: number): Int64;
/**
* Read an int8 value out of this segment.
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getInt8(byteOffset: number): number;
/**
* Read a uint16 value out of this segment.
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getUint16(byteOffset: number): number;
/**
* Read a uint32 value out of this segment.
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getUint32(byteOffset: number): number;
/**
* Read a uint8 value out of this segment.
* NOTE: this does not copy the memory region, so updates to the underlying buffer will affect the Uint64 value!
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getUint64(byteOffset: number): Uint64;
/**
* Read a uint8 value out of this segment.
*
* @param {number} byteOffset The offset in bytes to the value.
* @returns {number} The value.
*/
getUint8(byteOffset: number): number;
hasCapacity(byteLength: number): boolean;
/**
* Quickly check the word at the given offset to see if it is equal to zero.
*
* PERF_V8: Fastest way to do this is by reading the whole word as a `number` (float64) in the _native_ endian format
* and see if it's zero.
*
* Benchmark: http://jsben.ch/#/Pjooc
*
* @param {number} byteOffset The offset to the word.
* @returns {boolean} `true` if the word is zero.
*/
isWordZero(byteOffset: number): boolean;
/**
* Swap out this segment's underlying buffer with a new one. It's assumed that the new buffer has the same content but
* more free space, otherwise all existing pointers to this segment will be hilariously broken.
*
* @param {ArrayBuffer} buffer The new buffer to use.
* @returns {void}
*/
replaceBuffer(buffer: ArrayBuffer): void;
/** WARNING: This function is not yet implemented. */
setBigInt64(byteOffset: number, value: bigint, littleEndian?: boolean): void;
/** WARNING: This function is not yet implemented. */
setBigUint64(byteOffset: number, value: bigint, littleEndian?: boolean): void;
/**
* Write a float32 value to the specified offset.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {number} val The value to store.
* @returns {void}
*/
setFloat32(byteOffset: number, val: number): void;
/**
* Write an float64 value to the specified offset.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {number} val The value to store.
* @returns {void}
*/
setFloat64(byteOffset: number, val: number): void;
/**
* Write an int16 value to the specified offset.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {number} val The value to store.
* @returns {void}
*/
setInt16(byteOffset: number, val: number): void;
/**
* Write an int32 value to the specified offset.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {number} val The value to store.
* @returns {void}
*/
setInt32(byteOffset: number, val: number): void;
/**
* Write an int8 value to the specified offset.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {number} val The value to store.
* @returns {void}
*/
setInt8(byteOffset: number, val: number): void;
/**
* Write an int64 value to the specified offset.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {Int64} val The value to store.
* @returns {void}
*/
setInt64(byteOffset: number, val: Int64): void;
/**
* Write a uint16 value to the specified offset.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {number} val The value to store.
* @returns {void}
*/
setUint16(byteOffset: number, val: number): void;
/**
* Write a uint32 value to the specified offset.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {number} val The value to store.
* @returns {void}
*/
setUint32(byteOffset: number, val: number): void;
/**
* Write a uint64 value to the specified offset.
* TODO: benchmark other ways to perform this write operation.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {Uint64} val The value to store.
* @returns {void}
*/
setUint64(byteOffset: number, val: Uint64): void;
/**
* Write a uint8 (byte) value to the specified offset.
*
* @param {number} byteOffset The offset from the beginning of the buffer.
* @param {number} val The value to store.
* @returns {void}
*/
setUint8(byteOffset: number, val: number): void;
/**
* Write a zero word (8 bytes) to the specified offset. This is slightly faster than calling `setUint64` or
* `setFloat64` with a zero value.
*
* Benchmark: http://jsben.ch/#/dUdPI
*
* @param {number} byteOffset The offset of the word to set to zero.
* @returns {void}
*/
setWordZero(byteOffset: number): void;
toString(): string;
}
|