format

Documentation

Overview

Package format implements the age file format.

Index

• Constants
• Variables
• func DecodeString(s string) ([]byte, error)
• func NewlineWriter(dst io.Writer) io.Writer
• type Header
  • func Parse(input io.Reader) (*Header, io.Reader, error)
  • func (h *Header) Marshal(w io.Writer) error
  • func (h *Header) MarshalWithoutMAC(w io.Writer) error
• type ParseError
  • func (e ParseError) Error() string
• type Stanza
  • func (r *Stanza) Marshal(w io.Writer) error

Constants

const BytesPerLine = ColumnsPerLine / 4 * 3

const ColumnsPerLine = 64

Variables

var EncodeToString = b64.EncodeToString

Functions

func DecodeString

func DecodeString(s string) ([]byte, error)

func NewlineWriter

func NewlineWriter(dst io.Writer) io.Writer

NewlineWriter returns a Writer that writes to dst, inserting an LF character every ColumnsPerLine bytes. It does not insert a newline neither at the beginning nor at the end of the stream.

Types

type Header

type Header struct {
	Recipients []*Stanza
	MAC        []byte
}

func Parse

func Parse(input io.Reader) (*Header, io.Reader, error)

Parse returns the header and a Reader that begins at the start of the payload.

func (*Header) Marshal

func (h *Header) Marshal(w io.Writer) error

func (*Header) MarshalWithoutMAC

func (h *Header) MarshalWithoutMAC(w io.Writer) error

type ParseError

type ParseError string

func (ParseError) Error

func (e ParseError) Error() string

type Stanza

type Stanza struct {
	Type string
	Args []string
	Body []byte
}

Stanza is assignable to age.Stanza, and if this package is made public, age.Stanza can be made a type alias of this type.

func (*Stanza) Marshal

func (r *Stanza) Marshal(w io.Writer) error