Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

roles

package module

Go to main page

Versions in this module

v0

v0.1.3

Oct 1, 2026

Changes in this version

type BlobResult

+ func ClassifyPrefix(name string, prefix []byte) (BlobResult, error)

type Classifier

+ func (c *Classifier) ClassifyPrefix(name string, prefix []byte) (BlobResult, error)

type Result

+ func (r Result) Set() Set

type Set

+ func (s Set) BundledOrDerived() bool

v0.1.2

Oct 1, 2026

v0.1.1

Sep 22, 2026

Changes in this version

type Role

+ const Minified

v0.1.0

Sep 17, 2026

Changes in this version

+ const ContentVersion

+ const CorpusVersion

+ const DefaultMaxDepth

+ const DefaultMaxEntries

+ const MaxHeaderBytes

+ const MaxHeaderLines

+ var ErrInvalidPath = errors.New("expected a clean repository-relative path")

+ var ErrLimit = errors.New("repository traversal limit reached")

+ func IsLegalDirectory(name string) bool

+ func IsLegalDirectoryBytes(name []byte) bool

+ func LegalFileName(name string) (license, notice bool)

+ func LegalFileNameBytes(name []byte) (license, notice bool)

+ func Walk(tree fs.FS, options WalkOptions, visit func(string, Result) error) error

+ func WalkMatch(tree fs.FS, options WalkOptions, visit func(string, Set) error) error

+ type BlobResult struct

+ BytesExamined int

+ HeaderChecked bool

+ HeaderLimited bool

+ func ClassifyBlob(name string, contents []byte) (BlobResult, error)

+ func ClassifyReader(name string, reader io.Reader) (BlobResult, error)

+ type Classifier struct

+ func New(roots []VendorRoot) (*Classifier, error)

+ func (c *Classifier) Classify(name string) (Result, error)

+ func (c *Classifier) ClassifyBlob(name string, contents []byte) (BlobResult, error)

+ func (c *Classifier) ClassifyReader(name string, reader io.Reader) (BlobResult, error)

+ func (c *Classifier) Match(name string) (Set, error)

+ func (c *Classifier) RootState() State

+ func (c *Classifier) Walk(tree fs.FS, options WalkOptions, visit func(string, Result) error) error

+ func (c *Classifier) WalkMatch(tree fs.FS, options WalkOptions, visit func(string, Set) error) error

+ type Evidence struct

+ Ecosystem string

+ EvidencePath string

+ Path string

+ Role Role

+ Rule string

+ Source string

+ Subtype string

+ type Result struct

+ Evidence []Evidence

+ Roles []Role

+ func Classify(name string) (Result, error)

+ func (r Result) Has(role Role) bool

+ type Role string

+ const Benchmark

+ const Build

+ const BuildOutput

+ const CI

+ const Cache

+ const Configuration

+ const Documentation

+ const Example

+ const Fixture

+ const Fuzz

+ const Generated

+ const Legal

+ const Packaging

+ const Source

+ const Test

+ const Tooling

+ const Vendor

+ type Set uint32

+ func Match(name string) (Set, error)

+ func (s *Set) UnmarshalJSON(data []byte) error

+ func (s Set) Has(role Role) bool

+ func (s Set) List() []Role

+ func (s Set) MarshalJSON() ([]byte, error)

+ type State struct

+ func RootState() State

+ func (s State) Enter(name []byte) (State, error)

+ func (s State) Key() StateKey

+ func (s State) Match(name []byte) (Set, error)

+ func (s State) Roles() Set

+ type StateKey struct

+ type VendorRoot struct

+ Ecosystem string

+ EvidencePath string

+ Path string

+ type WalkOptions struct

+ MaxDepth int

+ MaxEntries int