capnptool

Documentation

Overview

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

Index

• type Tool
  • func Find() (Tool, error)
  • func (tool Tool) Decode(typ Type, r io.Reader) (string, error)
  • func (tool Tool) DecodePacked(typ Type, r io.Reader) (string, error)
  • func (tool Tool) Encode(typ Type, text string) ([]byte, error)
  • func (tool Tool) Run(stdin io.Reader, args ...string) ([]byte, error)
• type Type

Types

type Tool

type Tool string

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

func Find

func Find() (Tool, error)

Find searches PATH for the capnp tool.

func (Tool) Decode

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

Decode decodes a Cap'n Proto message into text.

func (Tool) DecodePacked

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

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

func (Tool) Encode

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

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

func (Tool) Run

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

type Type struct {
	SchemaPath string
	Name       string
}

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