text

Documentation

Overview

Package text supports marshaling Cap'n Proto messages as text based on a schema.

Index

• func Marshal(typeID uint64, s capnp.Struct) (string, error)
• func MarshalList(typeID uint64, l capnp.List) (string, error)
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (enc *Encoder) Encode(typeID uint64, s capnp.Struct) error
  • func (enc *Encoder) EncodeList(typeID uint64, l capnp.List) error
  • func (enc *Encoder) SetIndent(indent string)
  • func (enc *Encoder) UseRegistry(reg *schemas.Registry)

Functions

func Marshal

func Marshal(typeID uint64, s capnp.Struct) (string, error)

Marshal returns the text representation of a struct.

func MarshalList

func MarshalList(typeID uint64, l capnp.List) (string, error)

MarshalList returns the text representation of a struct list.

Types

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

An Encoder writes the text format of Cap'n Proto messages to an output stream.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns a new encoder that writes to w.

func (*Encoder) Encode

func (enc *Encoder) Encode(typeID uint64, s capnp.Struct) error

Encode writes the text representation of s to the stream.

func (*Encoder) EncodeList

func (enc *Encoder) EncodeList(typeID uint64, l capnp.List) error

EncodeList writes the text representation of struct list l to the stream.

func (*Encoder) SetIndent

func (enc *Encoder) SetIndent(indent string)

SetIndent sets string to indent each level with. An empty string disables indentation.

func (*Encoder) UseRegistry

func (enc *Encoder) UseRegistry(reg *schemas.Registry)

UseRegistry changes the registry that the encoder consults for schemas from the default registry.