protogen

Documentation

Index

• func MapEntryName(s string) string
• func PtrTo[T any](val T) *T
• func StartWithUpper(s string) string
• func ToProtoFieldName(s string) string
• func ToProtoIdentifier(s string) string
• type Comment
• type Comments
  • func (c *Comments) GetComment(key string) string
  • func (c *Comments) SetComment(key string, comment string)
• type OpenAPIConverter
  • func NewOpenAPIConverter(protoPackageName string, doc *openapi.Document) *OpenAPIConverter
  • func (c *OpenAPIConverter) Convert(ctx context.Context) (*descriptorpb.FileDescriptorProto, error)
• type ProtoWriter
  • func NewProtoWriter(w io.Writer) *ProtoWriter
  • func (p *ProtoWriter) Error() error
  • func (p *ProtoWriter) SetComments(comments *Comments)
  • func (p *ProtoWriter) SetProtoVersion(protoVersion int)
  • func (p *ProtoWriter) WriteFile(file protoreflect.FileDescriptor)

Functions

func MapEntryName

func MapEntryName(s string) string

See https://github.com/protocolbuffers/protobuf-go/blob/v1.32.0/internal/strs/strings.go#L125

func PtrTo

func PtrTo[T any](val T) *T

func StartWithUpper

func StartWithUpper(s string) string

func ToProtoFieldName

func ToProtoFieldName(s string) string

func ToProtoIdentifier

func ToProtoIdentifier(s string) string

Types

type Comment

type Comment struct {
	Text string
}

Comment is a comment on a message/field

type Comments

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

Comments holds all the comments for our messages / fields

func (*Comments) GetComment

func (c *Comments) GetComment(key string) string

func (*Comments) SetComment

func (c *Comments) SetComment(key string, comment string)

type OpenAPIConverter

type OpenAPIConverter struct {

	// Comments holds field and message level comments
	Comments
	// contains filtered or unexported fields
}

func NewOpenAPIConverter

func NewOpenAPIConverter(protoPackageName string, doc *openapi.Document) *OpenAPIConverter

func (*OpenAPIConverter) Convert

func (c *OpenAPIConverter) Convert(ctx context.Context) (*descriptorpb.FileDescriptorProto, error)

type ProtoWriter

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

func NewProtoWriter

func NewProtoWriter(w io.Writer) *ProtoWriter

func (*ProtoWriter) Error

func (p *ProtoWriter) Error() error

func (*ProtoWriter) SetComments

func (p *ProtoWriter) SetComments(comments *Comments)

func (*ProtoWriter) SetProtoVersion

func (p *ProtoWriter) SetProtoVersion(protoVersion int)

func (*ProtoWriter) WriteFile

func (p *ProtoWriter) WriteFile(file protoreflect.FileDescriptor)