protoconfig

type Configurable interface {
	// Decode parses byte slice as `Encoded Configuration Message` in JSON or proto format and unmarshal it on
	// the Configurable struct. It supports all `Proto Config Extensions Format 1.0` extenstion
	// (validation, default values etc).
	// Use `proto.Unmarshal` or `protojson.Unmarshal` for decoding without `ProtoConfig 1.0` extension support.
	Decode(ecm []byte) error
	// DecodeString parses string `Encoded Configuration Message` in JSON or proto format and unmarshal it on
	// the Configurable struct. It supports all `Proto Config Extensions Format 1.0` extenstion
	// (validation, default values etc).
	// Use `proto.Unmarshal` or `protojson.Unmarshal` for decoding without `ProtoConfig 1.0` extension support.
	DecodeString(ecm string) error
}

type Configurator interface {
	// Encode encodes self as `Encoded Configuration Message` in proto format so it can be understood and
	// passed to Configurable struct. It supports all `Proto Config Extensions Format 1.0` extenstion
	// (validation, default values etc).
	// Use `proto.Marshal` encoding without `ProtoConfig 1.0` extension support.
	Encode() ([]byte, error)
	// EncodeJSON encodes self as `Encoded Configuration Message` in JSON format so it can be understood and
	// passed to Configurable struct. It supports all `Proto Config Extensions Format 1.0` extenstion
	// Use `protojson.Marshal` encoding without `ProtoConfig 1.0` extension support.
	EncodeJSON() ([]byte, error)

	// Metadata returns metadata defined in `Proto Config Extensions Format 1.0`.
	Metadata() Metadata
}

type FlagDelivery struct {

	/// name represents custom flag name (including `-` if any) for a flag that consumes bytes of `Encoded Configuration Message`
	// ProtoConfig 1.0 recommends `--protoconfigv1` name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type Metadata struct {

	/// name represents name of annotated configuration entry point.
	/// It's recommended to use executable name here.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	/// version is the semantic version of the annotated configuration.
	Version     string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	/// delivery_mechanism optionally specifies the delivery that is implemented by configurable that consumes this
	/// configuration. This allows `Configurator` to discover how to pass the `Encoded Configuration Message`
	/// without extra information outside of definition.
	// TODO(bwplotka): This might be blocking reusability. Rethink?
	//
	// Types that are assignable to DeliveryMechanism:
	//	*Metadata_StdinDelivery
	//	*Metadata_FlagDelivery
	DeliveryMechanism isMetadata_DeliveryMechanism `protobuf_oneof:"delivery_mechanism"`
	// contains filtered or unexported fields
}

type Metadata_FlagDelivery struct {
	FlagDelivery *FlagDelivery `protobuf:"bytes,102,opt,name=flag_delivery,json=flagDelivery,proto3,oneof"`
}

type Metadata_StdinDelivery struct {
	StdinDelivery *StdinDelivery `protobuf:"bytes,101,opt,name=stdin_delivery,json=stdinDelivery,proto3,oneof"`
}

type StdinDelivery struct {
	// contains filtered or unexported fields
}