anmolitor/elm-protoc-types/1.0.0

NOTE: the latest version is 2.0.0

Formerly andreasewering/elm-protoc-types. Search finds this package by either name.

Proto.Google.Protobuf.Field

This file was automatically generated by

  • protoc-gen-elm 3.3.4
  • protoc 4.22.2
  • the following specification files: google/protobuf/type.proto

To run it, add a dependency via elm install on elm-protocol-buffers version latest or higher.

= CARDINALITYUNKNOWN
| CARDINALITYOPTIONAL
| CARDINALITYREQUIRED
| CARDINALITYREPEATED
| CardinalityUnrecognized_ Int

Whether a field is optional, required, or repeated.

type Kind
= TYPEUNKNOWN
| TYPEDOUBLE
| TYPEFLOAT
| TYPEINT64
| TYPEUINT64
| TYPEINT32
| TYPEFIXED64
| TYPEFIXED32
| TYPEBOOL
| TYPESTRING
| TYPEGROUP
| TYPEMESSAGE
| TYPEBYTES
| TYPEUINT32
| TYPEENUM
| TYPESFIXED32
| TYPESFIXED64
| TYPESINT32
| TYPESINT64
| KindUnrecognized_ Int

Basic field types.

Declares how to decode a Cardinality from Bytes. To actually perform the conversion from Bytes, you need to use Protobuf.Decode.decode from eriktim/elm-protocol-buffers.

decodeKind : Decoder Kind

Declares how to decode a Kind from Bytes. To actually perform the conversion from Bytes, you need to use Protobuf.Decode.decode from eriktim/elm-protocol-buffers.

Default for Cardinality. Should only be used for 'required' decoders as an initial value.

Default for Kind. Should only be used for 'required' decoders as an initial value.

Declares how to encode a Cardinality to Bytes. To actually perform the conversion to Bytes, you need to use Protobuf.Encode.encode from eriktim/elm-protocol-buffers.

encodeKind : Kind -> Encoder

Declares how to encode a Kind to Bytes. To actually perform the conversion to Bytes, you need to use Protobuf.Encode.encode from eriktim/elm-protocol-buffers.

The field numbers for the fields of Cardinality. This is mostly useful for internals, like documentation generation.

The field numbers for the fields of Kind. This is mostly useful for internals, like documentation generation.

Convert the internal type Proto__Google__Protobuf__Field__Cardinality into a Cardinality.

Using two different types is necessary to avoid recursive module references while having readable constructor names.

Convert the internal type Proto__Google__Protobuf__Field__Kind into a Kind.

Using two different types is necessary to avoid recursive module references while having readable constructor names.

Encode a Cardinality to JSON. Uses the canonical encoding described here: https://protobuf.dev/programming-guides/proto3/#json

jsonEncodeKind : Kind -> Value

Encode a Kind to JSON. Uses the canonical encoding described here: https://protobuf.dev/programming-guides/proto3/#json

Convert a Cardinality into its internal representation Proto__Google__Protobuf__Field__Cardinality.

Using two different types is necessary to avoid recursive module references while having readable constructor names.

Convert a Kind into its internal representation Proto__Google__Protobuf__Field__Kind.

Using two different types is necessary to avoid recursive module references while having readable constructor names.