scan

Documentation

Overview

* © 2024 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* © 2024 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Index

• type RepositoryTarget
  • func (r RepositoryTarget) GetPath() string
  • func (r RepositoryTarget) GetRepositoryUrl() string
  • func (r RepositoryTarget) String() string
• type ResultMetaData
• type Target
  • func NewRepositoryTarget(path string, options ...TargetOptions) (Target, error)
• type TargetOptions
  • func WithRepositoryUrl(repositoryUrl string) TargetOptions
• type Tracker
• type TrackerFactory
  • func NewNoopTrackerFactory() TrackerFactory

Types

type RepositoryTarget

type RepositoryTarget struct {
	LocalFilePath string
	// contains filtered or unexported fields
}

func (RepositoryTarget) GetPath

func (r RepositoryTarget) GetPath() string

func (RepositoryTarget) GetRepositoryUrl

func (r RepositoryTarget) GetRepositoryUrl() string

func (RepositoryTarget) String

func (r RepositoryTarget) String() string

type ResultMetaData

type ResultMetaData struct {
	FindingsUrl string
	WebUiUrl    string
}

type Target

type Target interface {
	GetPath() string
}

func NewRepositoryTarget

func NewRepositoryTarget(path string, options ...TargetOptions) (Target, error)

type TargetOptions

type TargetOptions func(*RepositoryTarget) error

func WithRepositoryUrl

func WithRepositoryUrl(repositoryUrl string) TargetOptions

type Tracker

type Tracker interface {
	Begin(title, message string)
	End(message string)
}

type TrackerFactory

type TrackerFactory interface {
	GenerateTracker() Tracker
}

func NewNoopTrackerFactory

func NewNoopTrackerFactory() TrackerFactory