an optional Uint8Array to use for reading. otherwise defaults to an empty Uint8Array for writing
Destroys the PBF instance. You can still use the Pbf instance after calling this method. However, the buffer will be emptied.
NOTE: bytes is preceeded by a varint dscribing the length of the bytes. The bytes themselves are presumed to be u8s and therefore don't need to be decoded
Read in a 64-bit float from the buffer. There are no compression advantages with this type of encoding.
If you know you are reading a message, but have already read the length of the message OR you're reading fields of the top level data, then this method is the alternative. It's often used by sub-classes So that it can be instationated prior to reading the message.
user defined input function to parse the message fields
The class to mutate given field data
the end position of the message in the buffer
Ex.
export class MapboxVectorLayer {
constructor(pbf: Protobuf, end: number) {
this.#pbf = pbf;
pbf.readFields(this.#readLayer, this, end);
}
#readLayer(tag: number, layer: MapboxVectorLayer, pbf: Protobuf): void {
if (tag === 15) layer.version = pbf.readVarint();
else if (tag === 1) layer.name = pbf.readString();
// ...
}
}
Read in a 32-bit unsigned integer from the buffer. There are no compression advantages with this type of encoding.
Read in a 64-bit unsigned integer from the buffer. There are no compression advantages with this type of encoding.
Read in a 32-bit float from the buffer. There are no compression advantages with this type of encoding.
Reads a message from the buffer. Sometimes it's easier to manage sub structures so that the current method can build multiples of an entire structure/class. If you you are at the top level, or parsing the message inside a class, then
user defined input function
an instance of the class you are reading into
the array to write to
arr input with the decoded boolean values is also returnedthe array to write to
arr input with the decoded doubles is also returnedthe array to write to
arr input with the decoded unsigned integers is also returnedthe array to write to
arr input with the decoded unsigned 64-bit integers is also returnedthe array to write to
arr input with the decoded floats is also returnedthe array to write to
arr input with the decoded signed integers is also returnedthe array to write to
arr input with the decoded signed 64-bit integers is also returnedthe array to write to
arr input with the decoded numbers is also returnedthe array to write to
true if the numbers are signed
arr input with the decoded numbers is also returnedRead in a 32-bit signed integer from the buffer. There are no compression advantages with this type of encoding.
Read in a 64-bit signed integer from the buffer. There are no compression advantages with this type of encoding.
Reads a tag from the buffer, pulls out the tag and type and returns it.
true if the number is signed
Skip a value we are not interested in parsing
the type to skip
Protobuffer Reader
Description
Create a new PBF instance read to it. Follows the early Protobuf spec supporting various types of encoding including messages (which are usually representative of class objects).
Usage
Reading: