file

Documentation

Index

• Constants
• type File
  • func CreateFile(buf []byte) (File, error)
  • func NewFile(format string) (File, error)

Constants

const (
	// Character Format (Fixed or variable blocked)
	CharacterFileFormat = "Character"
	// Packed Format (Variable blocked)
	PackedFileFormat = "Packed"
	// Name of header record
	HeaderRecordName = "header"
	// Name of trailer record
	TrailerRecordName = "trailer"
	// Name of data record
	DataRecordName = "data"
	// data with json format
	JsonData = "json"
	// data with metro format (raw data)
	MetroData = "metro"
)

Types

type File

type File interface {
	SetRecord(lib.Record) error
	AddDataRecord(lib.Record) error
	GetRecord(string) (lib.Record, error)
	GetDataRecords() []lib.Record
	GeneratorTrailer() (lib.Record, error)

	Parse(record string) error
	String() string
	Validate() error
}

General file interface

func CreateFile

func CreateFile(buf []byte) (File, error)

CreateFile attempts to parse raw metro2 file contents

func NewFile

func NewFile(format string) (File, error)

NewFile constructs a file template.