protobuf.js

API documentation

Class: Reader

Reader

Wire format reader using Uint8Array if available, otherwise Array.

new Reader(buffer)

src/reader.js, line 22

Constructs a new reader instance using the specified buffer.

Name Type Description
buffer Uint8Array

Buffer to read from

Members

buf { Uint8Array }

Read buffer.

len { number }

Read buffer length.

pos { number }

Read buffer position.

Methods

Reader.create(buffer){ Reader | BufferReader }

src/reader.js, line 63

Creates a new reader using the specified buffer.

Name Type Description
buffer Uint8Array | Buffer

Buffer to read from
Throws:
Type Description
Error

If buffer is not a valid buffer
Returns:
Type Description
Reader | BufferReader A BufferReader if buffer is a Buffer, otherwise a Reader

bool(){ boolean }

src/reader.js, line 199

Reads a varint as a boolean.

Returns:
Type Description
boolean Value read

bytes(){ Uint8Array }

src/reader.js, line 299

Reads a sequence of bytes preceeded by its length as a varint.

Returns:
Type Description
Uint8Array Value read

double(){ number }

src/reader.js, line 284

Reads a double (64 bit float) as a number.

Returns:
Type Description
number Value read

fixed32(){ number }

src/reader.js, line 214

Reads fixed 32 bits as an unsigned 32 bit integer.

Returns:
Type Description
number Value read

fixed64(){ Long }

src/reader.js, line 249

Reads fixed 64 bits.

Returns:
Type Description
Long Value read

float(){ number }

src/reader.js, line 268

Reads a float (32 bit) as a number.

Returns:
Type Description
number Value read

int32(){ number }

src/reader.js, line 104

Reads a varint as a signed 32 bit value.

Returns:
Type Description
number Value read

int64(){ Long }

src/reader.js, line 174

Reads a varint as a signed 64 bit value.

Returns:
Type Description
Long Value read

sfixed32(){ number }

src/reader.js, line 227

Reads fixed 32 bits as a signed 32 bit integer.

Returns:
Type Description
number Value read

sfixed64(){ Long }

src/reader.js, line 256

Reads zig-zag encoded fixed 64 bits.

Returns:
Type Description
Long Value read

sint32(){ number }

src/reader.js, line 112

Reads a zig-zag encoded varint as a signed 32 bit value.

Returns:
Type Description
number Value read

sint64(){ Long }

src/reader.js, line 188

Reads a zig-zag encoded varint as a signed 64 bit value.

Returns:
Type Description
Long Value read

skip(length){ Reader }

src/reader.js, line 330

Skips the specified number of bytes if specified, otherwise skips a varint.

Name Type Description
length number optional

Length if known, otherwise a varint is assumed
Returns:
Type Description
Reader this

skipType(wireType){ Reader }

src/reader.js, line 351

Skips the next element of the specified wire type.

Name Type Description
wireType number

Wire type received
Returns:
Type Description
Reader this

string(){ string }

src/reader.js, line 320

Reads a string preceeded by its byte length as a varint.

Returns:
Type Description
string Value read

uint32(){ number }

src/reader.js, line 82

Reads a varint as an unsigned 32 bit value.

Returns:
Type Description
number Value read

uint64(){ Long }

src/reader.js, line 181

Reads a varint as an unsigned 64 bit value.

Returns:
Type Description
Long Value read