file

Documentation

Index

• type File
  • func CreateFile(buf []byte) (File, error)
  • func NewFile(format string) (File, error)
  • func NewFileFromReader(r io.Reader) (File, error)
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) Read() (File, error)

Types

type File

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

	Parse(record []byte) error
	Bytes() []byte
	String(newline bool) string
	Validate() error
}

General file interface

func CreateFile

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

CreateFile attempts to parse raw metro2 or json

func NewFile

func NewFile(format string) (File, error)

NewFile constructs a file template.

func NewFileFromReader

func NewFileFromReader(r io.Reader) (File, error)

NewFileFromReader attempts to parse raw metro2 file or json file

type Reader

type Reader struct {

	// file is metro2 file model being built as r is parsed.
	File File
	// contains filtered or unexported fields
}

Reader reads records from a metro2 encoded file.

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns a new metro reader that reads from io reader.

func (*Reader) Read

func (r *Reader) Read() (File, error)

Read reads each record of the metro file