ByteInStream [constructor] | Constructors |
~ByteInStream [destructor] | Destroy this object. |
cursor | Return the index of the next byte to be extracted from this stream. |
data | Return the address of the contiguous, non-modifiable external memory buffer of this stream. The behavior of accessing elements outside the range [ data() .. data() + (length() - 1) ] is undefined. |
getArrayFloat32 | Assign to the specified variables the consecutive four-byte IEEE single-precision floating-point numbers (in host byte order) comprised of each of the specified numVariables four-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. |
getArrayFloat64 | Assign to the specified variables the consecutive eight-byte IEEE double-precision floating-point numbers (in host byte order) comprised of each of the specified numVariables eight-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. |
getArrayInt16 | Assign to the specified variables the consecutive two-byte, two's complement integers (in host byte order) comprised of each of the specified numVariables two-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be sign-extended. |
getArrayInt24 | Assign to the specified variables the consecutive three-byte, two's complement integers (in host byte order) comprised of each of the specified numVariables three-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numValues and variables has sufficient capacity. Note that each of the values will be sign-extended. |
getArrayInt32 | Assign to the specified variables the consecutive four-byte, two's complement integers (in host byte order) comprised of each of the specified numVariables four-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be sign-extended. |
getArrayInt40 | Assign to the specified variables the consecutive five-byte, two's complement integers (in host byte order) comprised of each of the specified numVariables five-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be sign-extended. |
getArrayInt48 | Assign to the specified variables the consecutive six-byte, two's complement integers (in host byte order) comprised of each of the specified numVariables six-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be sign-extended. |
getArrayInt56 | Assign to the specified variables the consecutive seven-byte, two's complement integers (in host byte order) comprised of each of the specified numVariables seven-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be sign-extended. |
getArrayInt64 | Assign to the specified variables the consecutive eight-byte, two's complement integers (in host byte order) comprised of each of the specified numVariables eight-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be sign-extended. |
getArrayInt8 | getArrayInt8 overloads |
getArrayUint16 | Assign to the specified variables the consecutive two-byte, two's complement unsigned integers (in host byte order) comprised of each of the specified numVariables two-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be zero-extended. |
getArrayUint24 | Assign to the specified variables the consecutive three-byte, two's complement unsigned integers (in host byte order) comprised of each of the specified numVariables three-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be zero-extended. |
getArrayUint32 | Assign to the specified variables the consecutive four-byte, two's complement unsigned integers (in host byte order) comprised of each of the specified numVariables four-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be zero-extended. |
getArrayUint40 | Assign to the specified variables the consecutive five-byte, two's complement unsigned integers (in host byte order) comprised of each of the specified numVariables five-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be zero-extended. |
getArrayUint48 | Assign to the specified variables the consecutive six-byte, two's complement unsigned integers (in host byte order) comprised of each of the specified numVariables six-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be zero-extended. |
getArrayUint56 | Assign to the specified variables the consecutive seven-byte, two's complement unsigned integers (in host byte order) comprised of each of the specified numVariables seven-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be zero-extended. |
getArrayUint64 | Assign to the specified variables the consecutive eight-byte, two's complement unsigned integers (in host byte order) comprised of each of the specified numVariables eight-byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be zero-extended. |
getArrayUint8 | getArrayUint8 overloads |
getFloat32 | Assign to the specified variable the four-byte IEEE single-precision floating-point number (in host byte order) comprised of the four bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. |
getFloat64 | Assign to the specified variable the eight-byte IEEE double-precision floating-point number (in host byte order) comprised of the eight bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. |
getInt16 | Assign to the specified variable the two-byte, two's complement integer (in host byte order) comprised of the two bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be sign-extended. |
getInt24 | Assign to the specified variable the three-byte, two's complement integer (in host byte order) comprised of the three bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be sign-extended. |
getInt32 | Assign to the specified variable the four-byte, two's complement integer (in host byte order) comprised of the four bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be sign-extended. |
getInt40 | Assign to the specified variable the five-byte, two's complement integer (in host byte order) comprised of the five bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be sign-extended. |
getInt48 | Assign to the specified variable the six-byte, two's complement integer (in host byte order) comprised of the six bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be sign-extended. |
getInt56 | Assign to the specified variable the seven-byte, two's complement integer (in host byte order) comprised of the seven bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be sign-extended. |
getInt64 | Assign to the specified variable the eight-byte, two's complement integer (in host byte order) comprised of the eight bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be sign-extended. |
getInt8 | getInt8 overloads |
getLength | If the most-significant bit of the one byte of this stream at the current cursor location is set, assign to the specified length the four-byte, two's complement integer (in host byte order) comprised of the four bytes of this stream at the current cursor location (in network byte order) with the most-significant bit unset; otherwise, assign to length the one-byte, two's complement integer comprised of the one byte of this stream at the current cursor location. Update the cursor location and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of length is undefined. Note that the value will be zero-extended. |
getString | Assign to the specified variable the string comprised of the length of the string (see getLength) and the string data (see getUint8), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. |
getUint16 | Assign to the specified variable the two-byte, two's complement unsigned integer (in host byte order) comprised of the two bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be zero-extended. |
getUint24 | Assign to the specified variable the three-byte, two's complement unsigned integer (in host byte order) comprised of the three bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be zero-extended. |
getUint32 | Assign to the specified variable the four-byte, two's complement unsigned integer (in host byte order) comprised of the four bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be zero-extended. |
getUint40 | Assign to the specified variable the five-byte, two's complement unsigned integer (in host byte order) comprised of the five bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be zero-extended. |
getUint48 | Assign to the specified variable the six-byte, two's complement unsigned integer (in host byte order) comprised of the six bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be zero-extended. |
getUint56 | Assign to the specified variable the seven-byte, two's complement unsigned integer (in host byte order) comprised of the seven bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be zero-extended. |
getUint64 | Assign to the specified variable the eight-byte, two's complement unsigned integer (in host byte order) comprised of the eight bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variable is undefined. Note that the value will be zero-extended. |
getUint8 | getUint8 overloads |
getVersion | Assign to the specified version the one-byte, two's complement unsigned integer comprised of the one byte of this stream at the current cursor location, update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of version is undefined. Note that the value will be zero-extended. |
invalidate | Put this input stream in an invalid state. This function has no effect if this stream is already invalid. Note that this function should be called whenever a value extracted from this stream is determined to be invalid, inconsistent, or otherwise incorrect. |
isEmpty | Return true if this stream is empty, and false otherwise. Note that this function enables higher-level types to verify that, after successfully reading all expected data, no data remains. |
isValid | Return true if this stream is valid, and false otherwise. An invalid stream is a stream in which insufficient or invalid data was detected during an extraction operation. Note that an empty stream will be valid unless an extraction attempt or explicit invalidation causes it to be otherwise. |
length | Return the total number of bytes stored in the external memory buffer. |
reset | reset overloads |
operator void const* | Return a non-zero value if this stream is valid, and 0 otherwise. An invalid stream is a stream for which an input operation was detected to have failed. |