capnptool

package

v2.18.2+incompatible Latest Latest Go to latest Published: May 13, 2021 License: MIT 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

Package capnptool provides an API for calling the capnp tool in tests.

This section is empty.

This section is empty.

This section is empty.

type Tool string

Tool is the path to the capnp command-line tool. It can be used from multiple goroutines.

func Find() (Tool, error)

Find searches PATH for the capnp tool.

func (tool Tool) Decode(typ Type, r io.Reader) (string, error)

Decode decodes a Cap'n Proto message into text.

func (tool Tool) DecodePacked(typ Type, r io.Reader) (string, error)

DecodePacked decodes a packed Cap'n Proto message into text.

func (tool Tool) Encode(typ Type, text string) ([]byte, error)

Encode encodes Cap'n Proto text into the binary representation.

func (tool Tool) Run(stdin io.Reader, args ...string) ([]byte, error)

Run executes the tool with the given stdin and arguments returns the stdout.

type Type struct {
	SchemaPath string
	Name       string
}

Type is a reference to a Cap'n Proto type in a schema.