adifparser

README

ADIFParser

ADIFParser is a Go library for reading and writing Amateur Data Interchange Format files. It wraps io.Reader and io.Writer interfaces to handle I/O and attempts to handle the irregularities of parsing files as much as possible.

Shortcomings

Currently, no validation of the content of fields is done. Also, no transformations are done, the fields are all handled as strings.

License

This library is released under a 2-clause BSD license. See COPYING for the license.

Bugs

Please report bugs on GitHub at https://github.com/Matir/adifparser, and please include an ADIF test case to demonstrate your bug.

Documentation

Index

• Constants
• Variables
• func NewADIFReader(r io.Reader) *baseADIFReader
• func NewADIFRecord() *baseADIFRecord
• func NewADIFWriter(w io.Writer) *baseADIFWriter
• func NewDedupeADIFReader(r io.Reader) *dedupeADIFReader
• func NewLOTWClient(username, password string) *lotwClientImpl
• type ADIFReader
• type ADIFRecord
• type ADIFWriter
• type LOTWClient

Constants

const (
	ADIFBoolean = iota
	ADIFNumber
	ADIFString
	ADIFDate
	ADIFTime
	ADIFLocation
)

const LOTWAPI string = "https://lotw.arrl.org/lotwuser/lotwreport.adi"

Variables

var ADIFfieldInfo map[string]fieldMetadata

var ADIFfieldOrder []string

var InvalidField = errors.New("Invalid field definition.")

var InvalidFieldLength = errors.New("Invalid field length.")

Errors

var NoData = errors.New("No data to parse.")

Errors

var NoSuchField = errors.New("No such field.")

var OutputStarted = errors.New("Output already started.")

var TypeCodeExceedOneByte = errors.New("Type Code exceeds one byte.")

var UnknownColons = errors.New("Unknown colons in the tag.")

Functions

func NewADIFReader

func NewADIFReader(r io.Reader) *baseADIFReader

func NewADIFRecord

func NewADIFRecord() *baseADIFRecord

Create a new ADIFRecord from scratch

func NewADIFWriter

func NewADIFWriter(w io.Writer) *baseADIFWriter

Construct a new writer

func NewDedupeADIFReader

func NewDedupeADIFReader(r io.Reader) *dedupeADIFReader

func NewLOTWClient

func NewLOTWClient(username, password string) *lotwClientImpl

Create a new client

Types

type ADIFReader

type ADIFReader interface {
	ReadRecord() (ADIFRecord, error)
	RecordCount() int
}

Interface for ADIFReader

type ADIFRecord

type ADIFRecord interface {
	// Print as ADIF String
	ToString() string
	// Fingerprint for duplication detection
	Fingerprint() string
	// Setters and getters
	GetValue(string) (string, error)
	SetValue(string, string)
	// Get all of the present field names
	GetFields() []string
}

Public interface for ADIFRecords

type ADIFWriter

type ADIFWriter interface {
	WriteRecord(ADIFRecord) error
	Flush() error
	SetComment(string) error
}

Basic writer type

type LOTWClient

type LOTWClient interface {
	// Implement reader
	Read([]byte) (int, error)
	Close() error
}