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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewContextWithScanSource ¶ added in v1.23.5
func NewContextWithScanSource(ctx context.Context, source ScanSource) context.Context
Types ¶
type LegacyScanStatus ¶ added in v1.23.1
func NewLegacyScanDoneStatus ¶ added in v1.23.1
func NewLegacyScanDoneStatus(message string) LegacyScanStatus
type RepositoryTarget ¶
type RepositoryTarget struct {
LocalFilePath string
// contains filtered or unexported fields
}
func (RepositoryTarget) GetCommitId ¶ added in v1.24.0
func (r RepositoryTarget) GetCommitId() string
func (RepositoryTarget) GetPath ¶
func (r RepositoryTarget) GetPath() string
func (RepositoryTarget) GetRepositoryUrl ¶
func (r RepositoryTarget) GetRepositoryUrl() string
func (RepositoryTarget) String ¶ added in v1.15.0
func (r RepositoryTarget) String() string
type ResultMetaData ¶ added in v1.15.0
type ScanSource ¶ added in v1.23.5
type ScanSource string
const ( LLM ScanSource = "LLM" IDE ScanSource = "IDE" CLI ScanSource = "CLI" )
func ScanSourceFromContext ¶ added in v1.23.5
func ScanSourceFromContext(ctx context.Context) (ScanSource, bool)
func (ScanSource) String ¶ added in v1.23.5
func (s ScanSource) String() 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 WithCommitId ¶ added in v1.24.0
func WithCommitId(commitId string) TargetOptions
func WithRepositoryUrl ¶
func WithRepositoryUrl(repositoryUrl string) TargetOptions
type TrackerFactory ¶ added in v1.6.0
type TrackerFactory interface {
GenerateTracker() Tracker
}
func NewNoopTrackerFactory ¶ added in v1.6.0
func NewNoopTrackerFactory() TrackerFactory
Source Files
Directories