Class: Field

ProtoBuf.Reflect.Message. Field

new Field(buildernon-null, messagenon-null, rule, type, name, id, optionsopt, oneofopt, non-null)

Constructs a new Message Field.

Parameters:
Name Type Attributes Description
builder ProtoBuf.Builder

Builder reference

message ProtoBuf.Reflect.Message

Message reference

rule string

Rule, one of requried, optional, repeated

type string

Data type, e.g. int32

name string

Field name

id number

Unique field id

options Object.<string, *> <optional>

Options

oneof ProtoBuf.Reflect.Message.OneOf <optional>

Enclosing OneOf

Source:

Extends

Members

(non-null) builder :ProtoBuf.Builder

Builder reference.

Type:
Inherited From:
Source:

className

Source:

defaultValue :*

Default value.

Type:
  • *
Source:

id :number

Unique message field id.

Type:
  • number
Source:

name :string

Object name in namespace.

Type:
  • string
Inherited From:
Source:

(nullable) oneof :ProtoBuf.Reflect.Message.OneOf

Enclosing OneOf.

Type:
Source:

(non-null) options :Object.<string, *>

Message field options.

Type:
Source:

originalName :string

Original field name.

Type:
  • string
Source:

(nullable) parent :ProtoBuf.Reflect.T

Parent object.

Type:
Inherited From:
Source:

repeated :boolean

Message field repeated flag.

Type:
  • boolean
Source:

required :boolean

Message field required flag.

Type:
  • boolean
Source:

resolvedType :ProtoBuf.Reflect.T|null

Resolved type reference inside the global namespace.

Type:
Source:

type :string|Object

Message field type. Type reference string if unresolved, protobuf type if resolved.

Type:
Source:

Methods

build()

Builds the field.

Source:

calculate(value) → {number}

Calculates the length of this field's value on the network level.

Parameters:
Name Type Description
value *

Field value

Source:
Returns:

Byte length

Type
number

calculateValue(value) → {number}

Calculates the byte length of a value.

Parameters:
Name Type Description
value *

Field value

Source:
Throws:
If the value cannot be calculated
Type
Error
Returns:

Byte length

Type
number

decode(wireType, buffer, skipRepeatedopt) → {*}

Decode the field value from the specified buffer.

Parameters:
Name Type Attributes Description
wireType number

Leading wire type

buffer ByteBuffer

ByteBuffer to decode from

skipRepeated boolean <optional>

Whether to skip the repeated check or not. Defaults to false.

Source:
Throws:
If the field cannot be decoded
Type
Error
Returns:

Decoded value

Type
*

encode(value, buffer) → {ByteBuffer}

Encodes the specified field value to the specified buffer.

Parameters:
Name Type Description
value *

Verified field value

buffer ByteBuffer

ByteBuffer to encode to

Source:
Throws:
If the field cannot be encoded
Type
Error
Returns:

The ByteBuffer for chaining

Type
ByteBuffer

encodeValue(value, buffer) → {ByteBuffer}

Encodes a value to the specified buffer. Does not encode the key.

Parameters:
Name Type Description
value *

Field value

buffer ByteBuffer

ByteBuffer to encode to

Source:
Throws:
If the value cannot be encoded
Type
Error
Returns:

The ByteBuffer for chaining

Type
ByteBuffer

fqn() → {string}

Returns the fully qualified name of this object.

Inherited From:
Source:
Returns:

Fully qualified name as of ".PATH.TO.THIS"

Type
string

toString(includeClassopt)

Returns a string representation of this Reflect object (its fully qualified name).

Parameters:
Name Type Attributes Description
includeClass boolean <optional>

Set to true to include the class name. Defaults to false.

Inherited From:
Source:
Returns:

String representation

verifyValue(value, skipRepeatedopt) → {*}

Checks if the given value can be set for this field.

Parameters:
Name Type Attributes Description
value *

Value to check

skipRepeated boolean <optional>

Whether to skip the repeated value check or not. Defaults to false.

Source:
Throws:
If the value cannot be set for this field
Type
Error
Returns:

Verified, maybe adjusted, value

Type
*