protostat

Documentation

Index

• type FileWalker
• type Stats
  • func GetStats(ctx context.Context, fileWalker FileWalker) (*Stats, error)

Types

type FileWalker

type FileWalker interface {
	// Walk will invoke f for all .proto files for GetStats.
	Walk(ctx context.Context, f func(io.Reader) error) error
}

FileWalker goes through all .proto files for GetStats.

type Stats

type Stats struct {
	NumFiles                 int `json:"num_files,omitempty" yaml:"num_files,omitempty"`
	NumPackages              int `json:"num_packages,omitempty" yaml:"num_packages,omitempty"`
	NumFilesWithSyntaxErrors int `json:"num_files_with_syntax_errors,omitempty" yaml:"num_files_with_syntax_errors,omitempty"`
	NumMessages              int `json:"num_messages,omitempty" yaml:"num_messages,omitempty"`
	NumFields                int `json:"num_fields,omitempty" yaml:"num_fields,omitempty"`
	NumEnums                 int `json:"num_enums,omitempty" yaml:"num_enums,omitempty"`
	NumEnumValues            int `json:"num_enum_values,omitempty" yaml:"num_enum_values,omitempty"`
	NumExtensions            int `json:"num_extensions,omitempty" yaml:"num_extensions,omitempty"`
	NumServices              int `json:"num_services,omitempty" yaml:"num_services,omitempty"`
	NumMethods               int `json:"num_methods,omitempty" yaml:"num_methods,omitempty"`
}

Stats represents some statistics about one or more Protobuf files.

func GetStats

func GetStats(ctx context.Context, fileWalker FileWalker) (*Stats, error)

GetStats gathers some simple statistics about a set of Protobuf files.

See the packages protostatos and protostatstorage for helpers for the os and storage packages.