Documentation
¶
Overview ¶
Package names caries the names database
Index ¶
- Constants
- func ClearCache()
- func CreateName(dbType DatabaseType, chain string, name *types.SimpleName) (err error)
- func LoadNamesArray(chain string, parts Parts, sortBy SortBy, terms []string) ([]types.SimpleName, error)
- func LoadNamesMap(chain string, parts Parts, terms []string) (map[base.Address]types.SimpleName, error)
- func ReadName(dbType DatabaseType, chain string, address base.Address) (name *types.SimpleName)
- func RemoveName(dbType DatabaseType, chain string, address base.Address) (name *types.SimpleName, err error)
- func SetDeleted(dbType DatabaseType, chain string, address base.Address, deleted bool) (name *types.SimpleName, err error)
- func UpdateName(dbType DatabaseType, chain string, name *types.SimpleName) (err error)
- func WriteNames(dbType DatabaseType, chain string, dryRun bool) (err error)
- type DatabaseType
- type NameReader
- type NameWriter
- type Parts
- type SortBy
Constants ¶
View Source
const ( NameReaderTab nameReaderMode = iota NameReaderComma )
View Source
const ( NameWriterCsv nameWriterFormat = iota NameWriterTsv )
Variables ¶
This section is empty.
Functions ¶
func CreateName ¶
func CreateName(dbType DatabaseType, chain string, name *types.SimpleName) (err error)
func LoadNamesArray ¶
func LoadNamesArray(chain string, parts Parts, sortBy SortBy, terms []string) ([]types.SimpleName, error)
LoadNamesArray loads the names from the cache and returns an array of names
func LoadNamesMap ¶
func LoadNamesMap(chain string, parts Parts, terms []string) (map[base.Address]types.SimpleName, error)
LoadNamesMap loads the names from the cache and returns a map of names
func ReadName ¶
func ReadName(dbType DatabaseType, chain string, address base.Address) (name *types.SimpleName)
func RemoveName ¶
func RemoveName(dbType DatabaseType, chain string, address base.Address) (name *types.SimpleName, err error)
func SetDeleted ¶
func SetDeleted(dbType DatabaseType, chain string, address base.Address, deleted bool) (name *types.SimpleName, err error)
func UpdateName ¶
func UpdateName(dbType DatabaseType, chain string, name *types.SimpleName) (err error)
func WriteNames ¶
func WriteNames(dbType DatabaseType, chain string, dryRun bool) (err error)
Types ¶
type DatabaseType ¶
type DatabaseType string
const ( DatabaseRegular DatabaseType = "names.tab" DatabaseCustom DatabaseType = "names_custom.tab" DatabasePrefund DatabaseType = "allocs.csv" DatabaseDryRun DatabaseType = "<dryrun>" )
type NameReader ¶
type NameReader struct {
// contains filtered or unexported fields
}
func NewNameReader ¶
func NewNameReader(source io.Reader, mode nameReaderMode) (NameReader, error)
func (*NameReader) Read ¶
func (gr *NameReader) Read() (types.SimpleName, error)
type NameWriter ¶
type NameWriter struct {
WriteHeader bool
Format nameWriterFormat
Header []string
// contains filtered or unexported fields
}
func NewNameWriter ¶
func NewNameWriter(destWriter io.Writer) *NameWriter
func (*NameWriter) Error ¶
func (w *NameWriter) Error() error
func (*NameWriter) Flush ¶
func (w *NameWriter) Flush()
func (*NameWriter) Write ¶
func (w *NameWriter) Write(name *types.SimpleName) (err error)
Source Files
Click to show internal directories.
Click to hide internal directories.