protocontract

package

v1.1.3 Latest Latest Go to latest Published: Mar 6, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Base struct {
	Package    string
	GoPackage  string
	HeaderPath string

	Messages     []string
	ImportsPaths []string

	Services []Service
}

type Contract struct {
	Base

	Desc *desc.FileDescriptor
}

Contract represents contract files with scope.

`HeaderPath` stores main contract path.
`[]ImportsPaths` stores paths of contracts which was imported in the main contract file.

func FromProtoDescriptor(descriptor *desc.FileDescriptor, protoPath string) (Contract, error)

FromProtoDescriptor converts proto descriptor into Contract model.

func (c Contract) HasMethods() bool

func (c Contract) IsProtoContract() bool

type MessageType struct {
	Name      string
	Package   string
	GoPackage string

	IsExternal bool
}

type Method struct {
	Name    string
	Package string

	InType  MessageType
	OutType MessageType

	MethodType types.ProtoMethodType
}

type Service struct {
	Name      string
	GoPackage string

	Methods []Method
}

type SetOfContracts []Contract

SetOfContracts is just alias for several contracts.

func (set SetOfContracts) HasContractsWithMethods() bool

func (set SetOfContracts) HasContractsWithProto() bool

func (set SetOfContracts) WithMethodsOnly() SetOfContracts

WithMethodsOnly returns only contracts with methods.