bmscanner

README

bmscanner

Scan bms packages

Documentation

Overview

Package bmscanner scan bms packages

Index

• type Package
• type ScanResult
• type Scanner
  • func NewScanner() *Scanner
  • func (sc *Scanner) Query() int
  • func (sc *Scanner) Scan(dir string) <-chan ScanResult

Types

type Package

type Package struct {
	PackageName      string
	PackageDirectory string
	ShardMD5         string
	Models           []sprout.BMSModel
	FileManifest     map[string]int
	BannerFileName   string
	BackBMPFileName  string
	StageFileName    string
}

type ScanResult

type ScanResult struct {
	Err        error
	Candidates []Package
}

type Scanner

type Scanner struct {
	// contains filtered or unexported fields
}

Scanner is a helper that manages a process of scanning. It's obvious that scanning directories, parsing files are heavy tasks. So the api of scanner is designed to be async

func NewScanner

func NewScanner() *Scanner

func (*Scanner) Query

func (sc *Scanner) Query() int

Query returns the current scanned packages count

func (*Scanner) Scan

func (sc *Scanner) Scan(dir string) <-chan ScanResult

Scan triggers a scanning process, which starts at directory 'dir'