utils

Documentation

Index

• Constants
• Variables
• func IsMetroFile(buf []byte) bool
• func IsPacked(buf []byte) bool
• func IsVariableLength(data []byte) bool
• func NewErrApplicableSegment(recordName, segName string) error
• func NewErrBlockDescriptorWord() error
• func NewErrFailedParsing() error
• func NewErrFieldRequired(fieldName, recordName string) error
• func NewErrInvalidRecord(name string) error
• func NewErrInvalidSegment(name string) error
• func NewErrInvalidValueOfField(fieldName, recordName string) error
• func NewErrNonAlphanumeric(fieldName, recordName string) error
• func NewErrNumeric(fieldName, recordName string) error
• func NewErrPhoneNumber(recordName string) error
• func NewErrSegmentLength(recordName string) error
• func NewErrUpperAlpha(fieldName, recordName string) error
• func NewErrValidDate(fieldName, recordName string) error
• func ReadFile(f *os.File) []byte
• type Time
  • func (ct *Time) IsZero() bool
  • func (ct Time) MarshalJSON() ([]byte, error)
  • func (ct *Time) String() string
  • func (ct *Time) UnmarshalJSON(b []byte) (err 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"

	// Json format
	MessageJsonFormat = "json"
	// Metro format
	MessageMetroFormat = "metro"
)

Variables

var (
	// ErrInvalidMetroFile is given when there's an invalid file
	ErrInvalidMetroFile = errors.New("the file isn't metro file")
	// ErrNonHeaderRecord is given when there isn't header record
	ErrNonHeaderRecord = errors.New("the file must have header record")
)

Functions

func IsMetroFile

func IsMetroFile(buf []byte) bool

Metro file check

func IsPacked

func IsPacked(buf []byte) bool

IsPacked packed format check

func IsVariableLength

func IsVariableLength(data []byte) bool

Variable block check

func NewErrApplicableSegment

func NewErrApplicableSegment(recordName, segName string) error

NewErrApplicableSegment returns a error that can't support applicable segment

func NewErrBlockDescriptorWord

func NewErrBlockDescriptorWord() error

NewErrBlockDescriptorWord returns a error that

func NewErrFailedParsing

func NewErrFailedParsing() error

NewErrFailedParsing returns a error that is failed parsing raw data

func NewErrFieldRequired

func NewErrFieldRequired(fieldName, recordName string) error

NewErrFieldRequired is given when a field is required

func NewErrInvalidRecord

func NewErrInvalidRecord(name string) error

NewErrInvalidRecord returns a error if is invalid record

func NewErrInvalidSegment

func NewErrInvalidSegment(name string) error

NewErrInvalidSegment returns a error that has invalid segment

func NewErrInvalidValueOfField

func NewErrInvalidValueOfField(fieldName, recordName string) error

NewErrInvalidValueOfField returns a error that has invalid value

func NewErrNonAlphanumeric

func NewErrNonAlphanumeric(fieldName, recordName string) error

NewErrNonAlphanumeric is given when a field has non-alphanumeric characters

func NewErrNumeric

func NewErrNumeric(fieldName, recordName string) error

NewErrNumeric is given when a field is not numeric characters

func NewErrPhoneNumber

func NewErrPhoneNumber(recordName string) error

NewErrPhoneNumber is given when a field is an invalid phone number

func NewErrSegmentLength

func NewErrSegmentLength(recordName string) error

NewErrSegmentLength is given when a segment has an invalid length

func NewErrUpperAlpha

func NewErrUpperAlpha(fieldName, recordName string) error

NewErrUpperAlpha is given when a field is not in uppercase

func NewErrValidDate

func NewErrValidDate(fieldName, recordName string) error

NewErrValidDate is given when there's an invalid date

func ReadFile

func ReadFile(f *os.File) []byte

File Read

Types

type Time

type Time time.Time

func (*Time) IsZero

func (ct *Time) IsZero() bool

IsZero reports whether t represents the zero time instant,

func (Time) MarshalJSON

func (ct Time) MarshalJSON() ([]byte, error)

MarshalJSON writes a quoted string in the custom format

func (*Time) String

func (ct *Time) String() string

String returns the time in the custom format

func (*Time) UnmarshalJSON

func (ct *Time) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON Parses the json string in the custom format