helpers

package

v1.4.1 Latest Latest Go to latest Published: May 9, 2024 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	CycloneDXFields = RequiredTag("cyclonedx")
)

View Source

var (
	// OptionalJSONTag uses field names defined in json tags, if available
	OptionalJSONTag = TrimOmitempty(OptionalTag("json"))
)

func Decode(typ reflect.Type, values map[string]string, prefix string, fn FieldName) interface{}

Decode based on the given type, applies all values to hydrate a new instance

func DecodeInto(obj interface{}, values map[string]string, prefix string, fn FieldName)

DecodeInto decodes all values to hydrate the given object instance

func DeriveBomRef(p pkg.Package) string

func Encode(obj interface{}, prefix string, fn FieldName) map[string]string

Encode recursively encodes the object's properties as an ordered set of NameValue pairs

func EncodeComponent(p pkg.Package) cyclonedx.Component

func EncodeProperties(obj interface{}, prefix string) (out []cyclonedx.Property)

func PtrToStruct(ptr interface{}) interface{}

func ToSyftModel(bom *cyclonedx.BOM) (*sbom.SBOM, error)

type FieldName func(field reflect.StructField) (string, bool)

FieldName return a flag to indicate this is a valid field and a name to use

func OptionalTag(tag string) FieldName

OptionalTag given a tag name, will return the defined tag or fall back to lower camel case field name

func RequiredTag(tag string) FieldName

RequiredTag based on the given tag, only use a field if present

func TrimOmitempty(fn FieldName) FieldName

TrimOmitempty trims `,omitempty` from the name

type NameValue struct {
	Name  string
	Value string
}

NameValue a simple type to store stringified name/value pairs

func Sorted(values map[string]string) (out []NameValue)

Sorted returns a sorted set of NameValue pairs