Protox.Types (Protox v1.2.3) View Source

This module describes types that define a protobuf message.

See https://developers.google.com/protocol-buffers/docs/encoding#structure.

Link to this section Summary

Types

kind()

This type give more details on how a field is encoded.

map_key_type()

All types that can be used as a key in map field.

tag()

The wire type of a field: it tells how a field is encoded (scalar, repeated, etc.).

type()

All types that can be stored in a protobuf message.

wire_32bits()

wire_64bits()

wire_delimited()

wire_varint()

Link to this section Types

kind()

Specs

kind() :: {:default, any()} | :packed | :unpacked | :map | {:oneof, atom()}

This type give more details on how a field is encoded.

map_key_type()

Specs

map_key_type() ::
  :int32
  | :int64
  | :uint32
  | :uint64
  | :sint32
  | :sint64
  | :fixed32
  | :fixed64
  | :sfixed32
  | :sfixed64
  | :bool
  | :string

All types that can be used as a key in map field.

tag()

Specs

tag() :: wire_varint() | wire_64bits() | wire_delimited() | wire_32bits()

The wire type of a field: it tells how a field is encoded (scalar, repeated, etc.).

type()

Specs

type() ::
  :fixed32
  | :sfixed32
  | :float
  | :fixed64
  | :sfixed64
  | :double
  | :int32
  | :uint32
  | :sint32
  | :int64
  | :uint64
  | :sint64
  | :bool
  | :string
  | :bytes
  | {:enum, atom()}
  | {:message, atom()}
  | {map_key_type(), type()}

All types that can be stored in a protobuf message.

wire_32bits()

Specs

wire_32bits() :: 5

wire_64bits()

Specs

wire_64bits() :: 1

wire_delimited()

Specs

wire_delimited() :: 2

wire_varint()

Specs

wire_varint() :: 0