id

Documentation

Overview

Package id list is responsible for id list managing

Index

• Variables
• func Index(i int, l ListT) (int, error)
• func ScUpdate() error
• func ScZero(SrcZ string, cmd *flag.FlagSet) error
• type Item
• type ListT
  • func (p *ListT) FileWatcher()
  • func (p *ListT) Read(fn string) error
  • func (p *ListT) Update(root, fn string, run, verbose bool) error

Variables

var (
	// List is the internal List instancem for 16 bit IDs enough
	List = make(ListT, 0, 65536)

	// FnJSON is the filename of the id list
	FnJSON string

	// Verbose, if set, gives more output information during update
	Verbose bool

	// DryRun, is set, inhibits real changes
	DryRun bool
)

Functions

func Index

func Index(i int, l ListT) (int, error)

Index returns the index of 'ID' inside 'l'. If 'ID' is not inside 'l' Index() returns 0 and an error.

func ScUpdate

func ScUpdate() error

ScUpdate is subcommand update

func ScZero

func ScZero(SrcZ string, cmd *flag.FlagSet) error

ScZero does replace all ID's in sourc tree with 0

Types

type Item

type Item struct {
	ID      int    `json:"id"`      // identifier
	FmtType string `json:"fmtType"` // format type (bitsize and number of fmt string parameters)
	FmtStrg string `json:"fmtStrg"` // format string
	Created int32  `json:"created"` // utc unix time of creation
	Removed int32  `json:"removed"` // utc unix time of disappearing in processed src directory
}

Item is the basic element

type ListT

type ListT []Item

List is a slice type containing the ID list

func (*ListT) FileWatcher

func (p *ListT) FileWatcher()

ListFileWatcher checks id list file for changes taken from https://medium.com/@skdomino/watch-this-file-watching-in-go-5b5a247cf71f

func (*ListT) Read

func (p *ListT) Read(fn string) error

Read is reading a JSON file fn and returning a slice

func (*ListT) Update

func (p *ListT) Update(root, fn string, run, verbose bool) error

Update is parsing source tree root and performing these actions: - replace FmtType( Id(0), ...) with FmtType( Id(n), ...) - find duplicate FmtType( Id(n), ...) and replace one of them if trices are not identical - extend file fnIDList