protoutil

Documentation

Index

• func Append(s *string, args ...string)
• func Camel2Case(name string) string
• func CamelCase(s string) string
• func CodeFormat(buf *bytes.Buffer) (string, error)
• func DefaultAPIOptions(pkg, srv, mth string) *options.HttpRule
• func ExtractAPIOptions(mth protoreflect.MethodDescriptor) (*options.HttpRule, error)
• func ExtractHttpMethod(opts *options.HttpRule) (method, path string)
• func Gen(g *protogen.GeneratedFile, tpl string, m pongo.Context)
• func ID(s string) string
• func Import(name string) func(id string) protogen.GoIdent
• func IsHelp() bool
• func Template(tpl string, m pongo.Context) string
• func UnExport(s string) string
• type Context
• type FilePath
  • func JoinPaths(elem ...string) FilePath
  • func (n FilePath) Base() string
  • func (n FilePath) BaseName() string
  • func (n FilePath) Dir() FilePath
  • func (n FilePath) Ext() string
  • func (n FilePath) Pop() FilePath
  • func (n FilePath) Push(elem string) FilePath
  • func (n FilePath) SetBase(base string) FilePath
  • func (n FilePath) SetExt(ext string) FilePath
  • func (n FilePath) String() string
• type Name
  • func (n Name) LowerCamelCase() Name
  • func (n Name) LowerDotNotation() Name
  • func (n Name) LowerSnakeCase() Name
  • func (n Name) ScreamingSnakeCase() Name
  • func (n Name) SnakeCase() Name
  • func (n Name) Split() (parts []string)
  • func (n Name) String() string
  • func (n Name) Transform(mod, first NameTransformer, sep string) Name
  • func (n Name) UpperCamelCase() Name
  • func (n Name) UpperDotNotation() Name
  • func (n Name) UpperSnakeCase() Name
• type NameTransformer
  • func (n NameTransformer) Chain(t NameTransformer) NameTransformer

Functions

func Append

func Append(s *string, args ...string)

func Camel2Case

func Camel2Case(name string) string

Camel2Case 驼峰式写法转为下划线写法

func CamelCase

func CamelCase(s string) string

CamelCase returns the CamelCased name. If there is an interior underscore followed by a lower case letter, drop the underscore and convert the letter to upper case. There is a remote possibility of this rewrite causing a name collision, but it's so remote we're prepared to pretend it's nonexistent - since the C++ generator lowercases names, it's extremely unlikely to have two fields with different capitalizations. In short, _my_field_name_2 becomes XMyFieldName_2.

func CodeFormat

func CodeFormat(buf *bytes.Buffer) (string, error)

CodeFormat go code format

func DefaultAPIOptions

func DefaultAPIOptions(pkg, srv, mth string) *options.HttpRule

DefaultAPIOptions This generates an HttpRule that matches the gRPC mapping to HTTP/2 described in https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests i.e.:

• method is POST
• path is "<pkg name>/<service name>/<method name>"
• body should contain the serialized request message

func ExtractAPIOptions

func ExtractAPIOptions(mth protoreflect.MethodDescriptor) (*options.HttpRule, error)

func ExtractHttpMethod

func ExtractHttpMethod(opts *options.HttpRule) (method, path string)

func Gen

func Gen(g *protogen.GeneratedFile, tpl string, m pongo.Context)

func ID

func ID(s string) string

ID is a NameTransformer that does not mutate the string.

func Import

func Import(name string) func(id string) protogen.GoIdent

func IsHelp

func IsHelp() bool

func Template

func Template(tpl string, m pongo.Context) string

func UnExport

func UnExport(s string) string

Types

type Context

type Context = pongo.Context

type FilePath

type FilePath string

A FilePath describes the name of a file or directory. This type simplifies path related operations.

func JoinPaths

func JoinPaths(elem ...string) FilePath

JoinPaths is an convenient alias around filepath.Join, to easily create FilePath types.

func (FilePath) Base

func (n FilePath) Base() string

Base returns the base of the current FilePath (the last element in the path). This method is an alias around filepath.Base.

func (FilePath) BaseName

func (n FilePath) BaseName() string

BaseName returns the Base of the current FilePath without Ext.

func (FilePath) Dir

func (n FilePath) Dir() FilePath

Dir returns the parent directory of the current FilePath. This method is an alias around filepath.Dir.

func (FilePath) Ext

func (n FilePath) Ext() string

Ext returns the extension of the current FilePath (starting at and including the last '.' in the FilePath). This method is an alias around filepath.Ext.

func (FilePath) Pop

func (n FilePath) Pop() FilePath

Pop returns a new FilePath with the last element removed. Pop is an alias for the Dir method.

func (FilePath) Push

func (n FilePath) Push(elem string) FilePath

Push returns a new FilePath with elem added to the end

func (FilePath) SetBase

func (n FilePath) SetBase(base string) FilePath

SetBase returns a new FilePath with the base element replaced with base.

func (FilePath) SetExt

func (n FilePath) SetExt(ext string) FilePath

SetExt returns a new FilePath with the extension replaced with ext.

func (FilePath) String

func (n FilePath) String() string

String satisfies the strings.Stringer interface.

type Name

type Name string

A Name describes an identifier of an Entity (Message, Field, Enum, Service, Field). It can be converted to multiple forms using the provided helper methods, or a custom transform can be used to modify its behavior.

func (Name) LowerCamelCase

func (n Name) LowerCamelCase() Name

LowerCamelCase converts Name n to lower camelcase, where each part is title-cased and concatenated with no separator except the first which is lower-cased.

func (Name) LowerDotNotation

func (n Name) LowerDotNotation() Name

LowerDotNotation converts Name n to lower dot notation, where each part is lower-cased and concatenated with periods.

func (Name) LowerSnakeCase

func (n Name) LowerSnakeCase() Name

LowerSnakeCase converts Name n to lower-snake-case, where each part is lower-cased and concatenated with underscores.

func (Name) ScreamingSnakeCase

func (n Name) ScreamingSnakeCase() Name

ScreamingSnakeCase converts Name n to screaming-snake-case, where each part is all-caps and concatenated with underscores.

func (Name) SnakeCase

func (n Name) SnakeCase() Name

SnakeCase converts Name n to snake-case, where each part preserves its capitalization and concatenated with underscores.

func (Name) Split

func (n Name) Split() (parts []string)

Split breaks apart Name n into its constituent components. Precedence follows dot notation, then underscores (excluding underscore prefixes), then camelcase. Numbers are treated as standalone components.

func (Name) String

func (n Name) String() string

String satisfies the strings.Stringer interface.

func (Name) Transform

func (n Name) Transform(mod, first NameTransformer, sep string) Name

Transform applies a transformation to the parts of Name n, returning a new Name. Transformer first is applied to the first part, with mod applied to all subsequent ones. The parts are then concatenated with the separator sep. For optimal efficiency, multiple NameTransformers should be Chained together before calling Transform.

func (Name) UpperCamelCase

func (n Name) UpperCamelCase() Name

UpperCamelCase converts Name n to upper camelcase, where each part is title-cased and concatenated with no separator.

func (Name) UpperDotNotation

func (n Name) UpperDotNotation() Name

UpperDotNotation converts Name n to upper dot notation, where each part is title-cased and concatenated with periods.

func (Name) UpperSnakeCase

func (n Name) UpperSnakeCase() Name

UpperSnakeCase converts Name n to upper-snake-case, where each part is title-cased and concatenated with underscores.

type NameTransformer

type NameTransformer func(string) string

NameTransformer is a function that mutates a string. Many of the methods in the standard strings package satisfy this signature.

func (NameTransformer) Chain

func (n NameTransformer) Chain(t NameTransformer) NameTransformer

Chain combines the behavior of two Transformers into one. If multiple transformations need to be performed on a Name, this method should be used to reduce it to a single transformation before applying.