Class Pbf

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.

See

readMessage.

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();
    ...
  }
}
Copy

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

See

readFields.

Ex.

class Test {
  a: number = 0;

  static read(tag: number, test: Test, pbf: Protobuf): void {
    if (tag === 1) test.a = pbf.readVarint();
    // ...
  }
}

const pbf = new Pbf(data);
const t = new Test();
pbf3.readTag();
pbf3.readMessage(Test.read, t);
Copy

Read 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.

See

readVarint for better performance

Allocate more space in the buffer

Skip a value we are not interested in parsing

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.

Write a packed repeated boolean array to the buffer with an associated tag.

Write a byte array

Write a packed repeated byte array to the buffer with an associated tag.

Write a 64-bit floating point number

Write a packed repeated double array to the buffer with an associated tag.

Write a 32-bit unsigned integer

write a packed repeated fixed 32-bit integer array to the buffer with an associated tag.

Write a 64-bit unsigned integer

Write a packed repeated unsigned 64-bit integer array to the buffer with an associated tag.

Write a 32-bit floating point number

Write a packed repeated float array to the buffer with an associated tag.

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.

Write a packed repeated 64-bit double array to the buffer.

Write a packed repeated 32-bit unsigned integer array to the buffer.

Write a packed repeated 64-bit unsigned integer array to the buffer.

Write a packed repeated 32-bit float array to the buffer.

Write a packed repeated 32-bit signed integer array to the buffer.

Write a packed repeated 64-bit signed integer array to the buffer.

Write a packed repeated signed whole number array to the buffer.

Write a packed repeated unsigned whole number array to the buffer.

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

Write a packed repeated signed 32-bit integer array to the buffer with an associated tag.

Write a 64-bit signed integer

Write a packed repeated signed 64-bit integer array to the buffer with an associated tag.

Write a signed varint. Can be max 64-bits. Numbers can be negative but must still be a while number.

Write a packed repeated signed integer array to the buffer with an associated tag.

Write a string. Strings larger then 128 bytes will be written in chunks of 128 bytes and are slightly less efficient.

Write a packed repeated string array to the buffer with an associated tag.

Write a tag and its associated type

Write a varint. Can be max 64-bits. Numbers are coerced to an unsigned while number before using this function.

Write a packed repeated unsigned integer array to the buffer with an associated tag.