igc

Documentation

Overview

Package igc implements an IGC parser.

Index

• type Encoder
  • func NewEncoder(w io.Writer, options ...EncoderOption) *Encoder
  • func (enc *Encoder) Encode(ls *geom.LineString) error
• type EncoderOption
  • func A(a string) EncoderOption
• type Errors
  • func (es Errors) Error() string
• type Header
• type T
  • func Read(r io.Reader) (*T, error)
  • func (t *T) HasCoords() bool

Types

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

An Encoder is an IGC encoder.

func NewEncoder

func NewEncoder(w io.Writer, options ...EncoderOption) *Encoder

NewEncoder returns a new Encoder that writes to w.

func (*Encoder) Encode

func (enc *Encoder) Encode(ls *geom.LineString) error

Encode encodes a LineString.

type EncoderOption

type EncoderOption func(*Encoder)

An EncoderOption sets an option on an Encoder.

func A

func A(a string) EncoderOption

A sets the A-record text.

type Errors

type Errors []error

An Errors is a slice of errors encountered.

func (Errors) Error

func (es Errors) Error() string

type Header

type Header struct {
	Source   string
	Key      string
	KeyExtra string
	Value    string
}

A Header is an IGC header.

type T

type T struct {
	Headers    []Header
	LineString *geom.LineString
}

A T represents a parsed IGC file.

func Read

func Read(r io.Reader) (*T, error)

Read reads a igc.T from r, which should contain IGC records.

IGC files in the wild are often corrupt, the IGC specification has been incomplete, and has evolved over time. The parser is consequently very tolerant of what it accepts and ignores several common errors. Consequently, the returned T might still contain headers and coordinates, even if the returned error is non-nil.

func (*T) HasCoords

func (t *T) HasCoords() bool

HasCoords returns true if t has at least one coordinate.