Documentation
¶
Index ¶
- func DefaultDetectors() []detectors.Detector
- func FragmentLineOffset(chunk *sources.Chunk, result *detectors.Result) int64
- type Engine
- func (e *Engine) ChunksChan() chan *sources.Chunk
- func (e *Engine) ChunksScanned() uint64
- func (e *Engine) DetectorAvgTime() map[string][]time.Duration
- func (e *Engine) Finish()
- func (e *Engine) ResultsChan() chan detectors.ResultWithMetadata
- func (e *Engine) ScanFileSystem(ctx context.Context, c sources.Config) error
- func (e *Engine) ScanGit(ctx context.Context, c sources.Config) error
- func (e *Engine) ScanGitHub(ctx context.Context, c sources.Config) error
- func (e *Engine) ScanGitLab(ctx context.Context, c sources.Config) error
- func (e *Engine) ScanS3(ctx context.Context, c sources.Config) error
- func (e *Engine) ScanSyslog(ctx context.Context, c sources.Config) error
- type EngineOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultDetectors ¶
Types ¶
type Engine ¶
type Engine struct {
// contains filtered or unexported fields
}
func (*Engine) ChunksChan ¶
func (*Engine) ChunksScanned ¶
func (*Engine) Finish ¶ added in v3.6.1
func (e *Engine) Finish()
Finish waits for running sources to complete and workers to finish scanning chunks before closing their respective channels. Once Finish is called, no more sources may be scanned by the engine.
func (*Engine) ResultsChan ¶
func (e *Engine) ResultsChan() chan detectors.ResultWithMetadata
func (*Engine) ScanFileSystem ¶
ScanFileSystem scans a given file system.
func (*Engine) ScanGitHub ¶
ScanGitHub scans Github with the provided options.
func (*Engine) ScanGitLab ¶
ScanGitLab scans GitLab with the provided configuration.
type EngineOption ¶
type EngineOption func(*Engine)
func WithConcurrency ¶
func WithConcurrency(concurrency int) EngineOption
func WithDecoders ¶
func WithDecoders(decoders ...decoders.Decoder) EngineOption
func WithDetectors ¶
func WithDetectors(verify bool, d ...detectors.Detector) EngineOption
Click to show internal directories.
Click to hide internal directories.