Protox v1.2.3

Protox.Encode (Protox v1.2.3) View Source

This module contains the functions necessary to encode protobuf messages and various types.

Protox users will want to use encode/1 and encode!/1 that take a protobuf message stored in a struct and that return an IO data that can be written to a file or a socket.

Link to this section Summary

Functions

encode(msg)
encode!(msg)
encode_bool(bool)
encode_bytes(value)
encode_double(value)
encode_enum(value)
encode_fixed32(value)
encode_fixed64(value)
encode_float(value)
encode_int32(value)
encode_int64(value)
encode_message(value)
encode_sfixed32(value)
encode_sfixed64(value)
encode_sint32(value)
encode_sint64(value)
encode_string(value)
encode_uint32(value)
encode_uint64(value)
encode_varint_32(value)
encode_varint_64(value)
encode_varint_signed(value)
make_key(tag, ty)
make_key_bytes(tag, ty)

Link to this section Functions

Link to this function

encode(msg)

View Source

Specs

encode(struct()) :: {:ok, iodata()} | {:error, any()}
Link to this function

encode!(msg)

View Source

Specs

encode!(struct()) :: iodata() | no_return()
Link to this function

encode_bool(bool)

View Source

Specs

encode_bool(boolean()) :: binary()
Link to this function

encode_bytes(value)

View Source

Specs

encode_bytes(binary()) :: iodata()
Link to this function

encode_double(value)

View Source

Specs

encode_double(float() | atom()) :: binary()
Link to this function

encode_enum(value)

View Source

Specs

encode_enum(integer()) :: iodata()
Link to this function

encode_fixed32(value)

View Source

Specs

encode_fixed32(integer()) :: binary()
Link to this function

encode_fixed64(value)

View Source

Specs

encode_fixed64(integer()) :: binary()
Link to this function

encode_float(value)

View Source

Specs

encode_float(float() | atom()) :: binary()
Link to this function

encode_int32(value)

View Source

Specs

encode_int32(integer()) :: iodata()
Link to this function

encode_int64(value)

View Source

Specs

encode_int64(integer()) :: iodata()
Link to this function

encode_message(value)

View Source

Specs

encode_message(struct()) :: iodata()
Link to this function

encode_sfixed32(value)

View Source

Specs

encode_sfixed32(integer()) :: binary()
Link to this function

encode_sfixed64(value)

View Source

Specs

encode_sfixed64(integer()) :: binary()
Link to this function

encode_sint32(value)

View Source

Specs

encode_sint32(integer()) :: iodata()
Link to this function

encode_sint64(value)

View Source

Specs

encode_sint64(integer()) :: iodata()
Link to this function

encode_string(value)

View Source

Specs

encode_string(String.t()) :: iodata()
Link to this function

encode_uint32(value)

View Source

Specs

encode_uint32(non_neg_integer()) :: iodata()
Link to this function

encode_uint64(value)

View Source

Specs

encode_uint64(non_neg_integer()) :: iodata()
Link to this function

encode_varint_32(value)

View Source

Specs

encode_varint_32(integer()) :: iodata()
Link to this function

encode_varint_64(value)

View Source

Specs

encode_varint_64(integer()) :: iodata()
Link to this function

encode_varint_signed(value)

View Source

Specs

encode_varint_signed(integer()) :: iodata()
Link to this function

make_key(tag, ty)

View Source

Specs

make_key(Protox.Types.tag(), Protox.Types.type()) :: non_neg_integer()
Link to this function

make_key_bytes(tag, ty)

View Source

Specs

make_key_bytes(Protox.Types.tag(), Protox.Types.type()) :: iodata()