machine

Documentation

Overview

Package machine encodes a model.Record as the stable JSON/NDJSON wire format described in docs/schema.md. The wire shapes here are a deliberately separate view-model from model.Record's Go-internal shapes (Field[T]'s generic {Value,Sources}, TimeValue's raw {Time,Raw,Parsed}) — this package owns the public API contract, and a breaking change to any shape below must bump SchemaVersion.

Index

• Constants
• func Encode(w io.Writer, r model.Record, opts Options) error
• func EncodeASN(w io.Writer, r model.ASNRecord, opts Options) error
• func EncodeASNNDJSON(w io.Writer, r model.ASNRecord, opts Options) error
• func EncodeError(w io.Writer, domainName string, err error) error
• func EncodeIP(w io.Writer, r model.IPRecord, opts Options) error
• func EncodeIPNDJSON(w io.Writer, r model.IPRecord, opts Options) error
• func EncodeNDJSON(w io.Writer, r model.Record, opts Options) error
• type Options

Constants

const SchemaVersion = 1

SchemaVersion is the current machine-output schema version.

Functions

func Encode

func Encode(w io.Writer, r model.Record, opts Options) error

Encode writes r as a single compact JSON object followed by a newline.

func EncodeASN

func EncodeASN(w io.Writer, r model.ASNRecord, opts Options) error

EncodeASN writes r as a single compact JSON object followed by a newline — the ASN-record counterpart to Encode.

func EncodeASNNDJSON

func EncodeASNNDJSON(w io.Writer, r model.ASNRecord, opts Options) error

EncodeASNNDJSON writes r as one compact JSON object followed by a newline — the shape used for -o ndjson multi-target output, one record per line. Mechanically identical to EncodeASN; kept as a separate name so call sites make the multi-target intent explicit.

func EncodeError

func EncodeError(w io.Writer, domainName string, err error) error

EncodeError writes a machine-mode error object to w: {"error": "...", "domain": "..."}. Used for stderr so stdout stays schema-clean even when a lookup fails in machine mode.

func EncodeIP

func EncodeIP(w io.Writer, r model.IPRecord, opts Options) error

EncodeIP writes r as a single compact JSON object followed by a newline — the IP-record counterpart to Encode.

func EncodeIPNDJSON

func EncodeIPNDJSON(w io.Writer, r model.IPRecord, opts Options) error

EncodeIPNDJSON writes r as one compact JSON object followed by a newline — the shape used for -o ndjson multi-target output, one record per line. Mechanically identical to EncodeIP; kept as a separate name so call sites make the multi-target intent explicit.

func EncodeNDJSON

func EncodeNDJSON(w io.Writer, r model.Record, opts Options) error

EncodeNDJSON writes r as one compact JSON object followed by a newline — the shape used for -o ndjson multi-domain output, one record per line. Mechanically identical to Encode; kept as a separate name so call sites make the multi-domain intent explicit.

Types

type Options

type Options struct {
	// Raw includes each source's raw response payload (sources[].raw).
	Raw bool
}

Options controls what Encode/EncodeNDJSON include.