transcribe

README

Transcribe for Go

Go programs often need to output data in a structured representation format, such as JSON or YAML. But why not provide wider compatibility and support all common formats, letting the user choose? This library provides a unified API over conversion to several formats.

It also supports "pretty" printing to terminals with semantic colorization (including "it just works" support for colorizing Windows terminals, which defy common standards).

Supported formats:

• YAML
• JSON, including a convention for extending JSON to support additional type differentiation
• XML via a conventional schema
• CBOR
• MessagePack

The binary formats (CBOR, MessagePack) can be output as is (incompatible with terminals) or textualized into Base64.

Documentation

Index

• Constants
• Variables
• func ColorizeYAML(code string, writer io.Writer) error
• func DumpYAMLNode(writer io.Writer, node *yaml.Node, indent int)
• func DumpYAMLNodes(writer io.Writer, node *yaml.Node)
• func NewJSONColorFormatter(indent int) *prettyjson.Formatter
• func OpenFileForWrite(path string) (*os.File, error)
• type Transcriber
  • func NewTranscriber() *Transcriber
  • func (self *Transcriber) NewUtterConfig() *utter.ConfigState
  • func (self *Transcriber) Print(value any, writer io.Writer, format string) error
  • func (self *Transcriber) PrintCBOR(value any, writer io.Writer) error
  • func (self *Transcriber) PrintGo(value any, writer io.Writer) error
  • func (self *Transcriber) PrintJSON(value any, writer io.Writer) error
  • func (self *Transcriber) PrintMessagePack(value any, writer io.Writer) error
  • func (self *Transcriber) PrintString(value any, writer io.Writer) error
  • func (self *Transcriber) PrintXJSON(value any, writer io.Writer) error
  • func (self *Transcriber) PrintXML(value any, writer io.Writer) error
  • func (self *Transcriber) PrintXMLDocument(xmlDocument *etree.Document, writer io.Writer) error
  • func (self *Transcriber) PrintYAML(value any, writer io.Writer) error
  • func (self *Transcriber) Stringify(value any, format string) (string, error)
  • func (self *Transcriber) StringifyCBOR(value any) (string, error)
  • func (self *Transcriber) StringifyGo(value any) (string, error)
  • func (self *Transcriber) StringifyJSON(value any) (string, error)
  • func (self *Transcriber) StringifyMessagePack(value any) (string, error)
  • func (self *Transcriber) StringifyXJSON(value any) (string, error)
  • func (self *Transcriber) StringifyXML(value any) (string, error)
  • func (self *Transcriber) StringifyYAML(value any) (string, error)
  • func (self *Transcriber) WithIndent(indent string) *Transcriber
  • func (self *Transcriber) Write(value any, writer io.Writer, format string) error
  • func (self *Transcriber) WriteCBOR(value any, writer io.Writer) error
  • func (self *Transcriber) WriteGo(value any, writer io.Writer) error
  • func (self *Transcriber) WriteJSON(value any, writer io.Writer) error
  • func (self *Transcriber) WriteMessagePack(value any, writer io.Writer) error
  • func (self *Transcriber) WriteOrPrint(value any, writer io.Writer, output string, format string) error
  • func (self *Transcriber) WriteToFile(value any, output string, format string) error
  • func (self *Transcriber) WriteXJSON(value any, writer io.Writer) error
  • func (self *Transcriber) WriteXML(value any, writer io.Writer) error
  • func (self *Transcriber) WriteXMLDocument(xmlDocument *etree.Document, writer io.Writer) error
  • func (self *Transcriber) WriteYAML(value any, writer io.Writer) error

Constants

const DIRECTORY_WRITE_PERMISSIONS = 0700

const FILE_WRITE_PERMISSIONS = 0600

Variables

var YAMLNodeKinds = map[yaml.Kind]string{
	yaml.DocumentNode: "Document",
	yaml.SequenceNode: "Sequence",
	yaml.MappingNode:  "Mapping",
	yaml.ScalarNode:   "Scalar",
	yaml.AliasNode:    "Alias",
}

Functions

func ColorizeYAML

func ColorizeYAML(code string, writer io.Writer) error

func DumpYAMLNode

func DumpYAMLNode(writer io.Writer, node *yaml.Node, indent int)

func DumpYAMLNodes

func DumpYAMLNodes(writer io.Writer, node *yaml.Node)

func NewJSONColorFormatter

func NewJSONColorFormatter(indent int) *prettyjson.Formatter

func OpenFileForWrite

func OpenFileForWrite(path string) (*os.File, error)

Types

type Transcriber

type Transcriber struct {
	Indent    string
	Strict    bool
	Pretty    bool // only applies to Print; when true then Indent is ignored
	Base64    bool
	Reflector *ard.Reflector
}

func NewTranscriber

func NewTranscriber() *Transcriber

func (*Transcriber) NewUtterConfig

func (self *Transcriber) NewUtterConfig() *utter.ConfigState

func (*Transcriber) Print

func (self *Transcriber) Print(value any, writer io.Writer, format string) error

When Pretty is true, takes into account terminal.Colorize and uses terminal.Indent or terminal.IndentSpaces, overriding our Indent.

If value is a [string] will print it as is, ignoring the format argument.

If value is a *etree.Document will use Transcriber.PrintXMLDocument, ignoring the format argument.

func (*Transcriber) PrintCBOR

func (self *Transcriber) PrintCBOR(value any, writer io.Writer) error

func (*Transcriber) PrintGo

func (self *Transcriber) PrintGo(value any, writer io.Writer) error

func (*Transcriber) PrintJSON

func (self *Transcriber) PrintJSON(value any, writer io.Writer) error

func (*Transcriber) PrintMessagePack

func (self *Transcriber) PrintMessagePack(value any, writer io.Writer) error

func (*Transcriber) PrintString

func (self *Transcriber) PrintString(value any, writer io.Writer) error

func (*Transcriber) PrintXJSON

func (self *Transcriber) PrintXJSON(value any, writer io.Writer) error

func (*Transcriber) PrintXML

func (self *Transcriber) PrintXML(value any, writer io.Writer) error

func (*Transcriber) PrintXMLDocument

func (self *Transcriber) PrintXMLDocument(xmlDocument *etree.Document, writer io.Writer) error

func (*Transcriber) PrintYAML

func (self *Transcriber) PrintYAML(value any, writer io.Writer) error

func (*Transcriber) Stringify

func (self *Transcriber) Stringify(value any, format string) (string, error)

func (*Transcriber) StringifyCBOR

func (self *Transcriber) StringifyCBOR(value any) (string, error)

Note: will always use base64.

func (*Transcriber) StringifyGo

func (self *Transcriber) StringifyGo(value any) (string, error)

func (*Transcriber) StringifyJSON

func (self *Transcriber) StringifyJSON(value any) (string, error)

func (*Transcriber) StringifyMessagePack

func (self *Transcriber) StringifyMessagePack(value any) (string, error)

Note: will always use base64.

func (*Transcriber) StringifyXJSON

func (self *Transcriber) StringifyXJSON(value any) (string, error)

func (*Transcriber) StringifyXML

func (self *Transcriber) StringifyXML(value any) (string, error)

func (*Transcriber) StringifyYAML

func (self *Transcriber) StringifyYAML(value any) (string, error)

func (*Transcriber) WithIndent

func (self *Transcriber) WithIndent(indent string) *Transcriber

func (*Transcriber) Write

func (self *Transcriber) Write(value any, writer io.Writer, format string) error

func (*Transcriber) WriteCBOR

func (self *Transcriber) WriteCBOR(value any, writer io.Writer) error

func (*Transcriber) WriteGo

func (self *Transcriber) WriteGo(value any, writer io.Writer) error

func (*Transcriber) WriteJSON

func (self *Transcriber) WriteJSON(value any, writer io.Writer) error

func (*Transcriber) WriteMessagePack

func (self *Transcriber) WriteMessagePack(value any, writer io.Writer) error

func (*Transcriber) WriteOrPrint

func (self *Transcriber) WriteOrPrint(value any, writer io.Writer, output string, format string) error

Convenience function. If output is an empty string will be identical to Transcriber.Print, otherwise will call Transcriber.WriteToFile on the output, ignoring the writer argument.

func (*Transcriber) WriteToFile

func (self *Transcriber) WriteToFile(value any, output string, format string) error

Opens the output file for write and calls Transcriber.Write on it.

func (*Transcriber) WriteXJSON

func (self *Transcriber) WriteXJSON(value any, writer io.Writer) error

func (*Transcriber) WriteXML

func (self *Transcriber) WriteXML(value any, writer io.Writer) error

func (*Transcriber) WriteXMLDocument

func (self *Transcriber) WriteXMLDocument(xmlDocument *etree.Document, writer io.Writer) error

func (*Transcriber) WriteYAML

func (self *Transcriber) WriteYAML(value any, writer io.Writer) error