inspect

package
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 13, 2026 License: BSD-3-Clause Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Metadata

type Metadata struct {
	Version     string   `json:"version"`
	Postquantum string   `json:"postquantum"` // "yes" or "no" or "unknown"
	Armor       bool     `json:"armor"`
	StanzaTypes []string `json:"stanza_types"`
	Sizes       struct {
		Header   int64 `json:"header"`
		Armor    int64 `json:"armor"`
		Overhead int64 `json:"overhead"`
		// Currently, we don't do any padding, so MinPayload == MaxPayload and
		// MinPadding == MaxPadding == 0, but that might change in the future.
		MinPayload int64 `json:"min_payload"`
		MaxPayload int64 `json:"max_payload"`
		MinPadding int64 `json:"min_padding"`
		MaxPadding int64 `json:"max_padding"`
	} `json:"sizes"`
}

func Inspect

func Inspect(r io.Reader, fileSize int64) (*Metadata, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL