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
Allocate more space in the buffer
the minimum number of bytes to allocate
Skip a value we are not interested in parsing
the type to skip
Write a boolean value. Can also be a number, in which case it will be converted to a boolean. 0 is false, anything else is true.
the boolean to write.
Write a packed repeated boolean array to the buffer with an associated tag.
the tag to write to associate with the value.
the boolean to write.
Write a byte array
a Buffer to write. Will write the length of the buffer first. After that, the buffer will be written byte by byte.
Write a packed repeated byte array to the buffer with an associated tag.
the tag to write to associate with the value.
the buffer of bytes to write.
Write a 64-bit floating point number
a 64-bit floating point number to write
Write a packed repeated double array to the buffer with an associated tag.
the tag to write to associate with the value.
the double to write.
Write a 32-bit unsigned integer
the 32-bit unsigned integer to write
write a packed repeated fixed 32-bit integer array to the buffer with an associated tag.
the tag to write to associate with the value.
the unsigned 32-bit integer to write.
Write a 64-bit unsigned integer
the 64-bit unsigned integer to write
Write a packed repeated unsigned 64-bit integer array to the buffer with an associated tag.
the tag to write to associate with the value.
the unsigned 64-bit integer to write.
Write a 32-bit floating point number
a 32-bit floating point number to write
Write a packed repeated float array to the buffer with an associated tag.
the tag to write to associate with the value.
the float to write.
Write a message to the buffer. Allows you to pass in an object with a write function to define how the message should be written. A good tool to abstract away storing classes or sub-classes.
Write a packed repeated boolean array to the buffer.
Supports numbers: 0 is false, everything else is true.
the tag to write to associate with the value.
the array of booleans to write.
Write a packed repeated 64-bit double array to the buffer.
the tag to write to associate with the value.
the array of doubles to write.
Write a packed repeated 32-bit unsigned integer array to the buffer.
the tag to write to associate with the value.
the array of unsigned 32-bit numbers to write.
Write a packed repeated 64-bit unsigned integer array to the buffer.
the tag to write to associate with the value.
the array of unsigned 64-bit numbers to write.
Write a packed repeated 32-bit float array to the buffer.
the tag to write to associate with the value.
the array of floats to write.
Write a packed repeated 32-bit signed integer array to the buffer.
the tag to write to associate with the value.
the array of signed 32-bit numbers to write.
Write a packed repeated 64-bit signed integer array to the buffer.
the tag to write to associate with the value.
the array of signed 64-bit numbers to write.
Write a packed repeated signed whole number array to the buffer.
the tag to write to associate with the value.
the array of signed whole numbers to write.
Write a packed repeated unsigned whole number array to the buffer.
the tag to write to associate with the value.
the array of unsigned whole numbers to write.
Write a message to the buffer. Allows you to pass in an object with a write function to define how the message should be written. A good tool to abstract away storing classes or sub-classes.
Write a 32-bit signed integer
the 32-bit signed integer to write
Write a packed repeated signed 32-bit integer array to the buffer with an associated tag.
the tag to write to associate with the value.
the signed 32-bit integer to write.
Write a 64-bit signed integer
the 64-bit signed integer to write
Write a packed repeated signed 64-bit integer array to the buffer with an associated tag.
the tag to write to associate with the value.
the signed 64-bit integer to write.
Write a string. Strings larger then 128 bytes will be written in chunks of 128 bytes and are slightly less efficient.
the string to write
Write a packed repeated string array to the buffer with an associated tag.
the tag to write to associate with the value.
the string to write.
Write a signed varint. Can be max 64-bits. Numbers can be negative but must still be a while number.
any whole signed number. It's usually best practice to not use this function directly unless you know what you're doing.
Write a packed repeated signed integer array to the buffer with an associated tag.
the tag to write to associate with the value.
the signed number to write.
Write a tag and its associated type
the tag to write
the type to write (will never be greater than 3 bits)
Write a varint. Can be max 64-bits. Numbers are coerced to an unsigned while number before using this function.
any whole unsigned number. It's usually best practice to not use this function directly unless you know what you're doing.
Write a packed repeated unsigned integer array to the buffer with an associated tag.
the tag to write to associate with the value.
the unsigned number to write.
Protobuffer Reader and Writer
Description
Create a new PBF instance and either read or write to it. Follows the early Protobuf spec supporting various types of encoding including messages (which are usually representative of class objects).
Usage
Reading:
Writing: