internal

Documentation

Overview

Package internal contains miscellaneous functions and objects useful within syft but should not be used externally.

Index

• Constants
• func CloseAndLogError(closer io.Closer, location string)
• func HasAnyOfPrefixes(input string, prefixes ...string) bool
• func IsErrPath(err error) bool
• func IsErrPathPermission(err error) bool
• func IsPipedInput() (bool, error)
• func IsTerminal() bool
• func MatchNamedCaptureGroups(regEx *regexp.Regexp, content string) map[string]string
• func NewBufferedSeeker(rc io.ReadCloser) io.ReadSeekCloser
• func SplitAny(s string, seps string) []string
• func StringInSlice(a string, list []string) bool
• func Tprintf(tmpl string, data map[string]interface{}) string
• func TruncateMiddleEllipsis(input string, maxLen int) string
• type ErrPath
  • func (e ErrPath) Error() string
• type Set
  • func NewSet[T comparable](start ...T) Set[T]
  • func (s Set[T]) Add(elements ...T)
  • func (s Set[T]) Contains(element T) bool
  • func (s Set[T]) Empty() bool
  • func (s Set[T]) Equals(o Set[T]) bool
  • func (s Set[T]) Remove(element T)
  • func (s Set[T]) ToSlice() []T

Constants

const (
	// JSONSchemaVersion is the current schema version output by the JSON encoder
	// This is roughly following the "SchemaVer" guidelines for versioning the JSON schema. Please see schema/json/README.md for details on how to increment.
	JSONSchemaVersion = "16.0.18"
)

Functions

func CloseAndLogError

func CloseAndLogError(closer io.Closer, location string)

CloseAndLogError closes the given io.Closer and reports any errors found as a warning in the log

func HasAnyOfPrefixes

func HasAnyOfPrefixes(input string, prefixes ...string) bool

HasAnyOfPrefixes returns an indication if the given string has any of the given prefixes.

func IsErrPath

func IsErrPath(err error) bool

func IsErrPathPermission

func IsErrPathPermission(err error) bool

func IsPipedInput

func IsPipedInput() (bool, error)

IsPipedInput returns true if there is no input device, which means the user **may** be providing input via a pipe.

func IsTerminal

func IsTerminal() bool

IsTerminal returns true if there is a terminal present.

func MatchNamedCaptureGroups

func MatchNamedCaptureGroups(regEx *regexp.Regexp, content string) map[string]string

MatchNamedCaptureGroups takes a regular expression and string and returns all of the named capture group results in a map. This is only for the first match in the regex. Callers shouldn't be providing regexes with multiple capture groups with the same name.

func NewBufferedSeeker

func NewBufferedSeeker(rc io.ReadCloser) io.ReadSeekCloser

func SplitAny

func SplitAny(s string, seps string) []string

func StringInSlice

func StringInSlice(a string, list []string) bool

func Tprintf

func Tprintf(tmpl string, data map[string]interface{}) string

Tprintf renders a string from a given template string and field values

func TruncateMiddleEllipsis

func TruncateMiddleEllipsis(input string, maxLen int) string

Types

type ErrPath

type ErrPath struct {
	Context string
	Path    string
	Err     error
}

func (ErrPath) Error

func (e ErrPath) Error() string

type Set

type Set[T comparable] map[T]struct{}

Set represents a generic set type.

func NewSet

func NewSet[T comparable](start ...T) Set[T]

NewSet creates a new empty Set.

func (Set[T]) Add

func (s Set[T]) Add(elements ...T)

Add adds elements to the set.

func (Set[T]) Contains

func (s Set[T]) Contains(element T) bool

Contains checks if an element is in the set.

func (Set[T]) Empty

func (s Set[T]) Empty() bool

Empty checks if the set is empty.

func (Set[T]) Equals

func (s Set[T]) Equals(o Set[T]) bool

Equals checks if two sets are equal.

func (Set[T]) Remove

func (s Set[T]) Remove(element T)

Remove removes an element from the set.

func (Set[T]) ToSlice

func (s Set[T]) ToSlice() []T

ToSlice returns a sorted slice of elements in the set.