encoding

Documentation

Overview

Package encoding defines types that deal with document encoding. Genji codecs are designed to support buffer reuse during encoding and optional random-access, i.e. decoding one path without decoding the entire document, during decoding.

Index

• type Codec
• type Encoder

Types

type Codec

type Codec interface {
	NewEncoder(io.Writer) Encoder
	// NewDocument returns a document without decoding its given binary representation.
	// The returned document should ideally support random-access, i.e. decoding one path
	// without decoding the entire document. If not, the document must be lazily decoded.
	NewDocument([]byte) document.Document
}

A Codec is able to create encoders and decoders for a specific encoding format.

type Encoder

type Encoder interface {
	EncodeDocument(d document.Document) error
	// Close the encoder to release any resource.
	Close()
}

An Encoder encodes one document to the underlying writer.