formats

Documentation

Index

• func AllIDs() (ids []sbom.FormatID)
• func ByName(name string) sbom.Format
• func ByNameAndVersion(name string, version string) sbom.Format
• func Decode(reader io.Reader) (*sbom.SBOM, sbom.Format, error)
• func Encode(s sbom.SBOM, f sbom.Format) ([]byte, error)
• func Formats() []sbom.Format
• func Identify(by []byte) sbom.Format

Functions

func AllIDs

func AllIDs() (ids []sbom.FormatID)

func ByName

func ByName(name string) sbom.Format

ByName accepts a name@version string, such as:

spdx-json@2.1 or cyclonedx@2

func ByNameAndVersion

func ByNameAndVersion(name string, version string) sbom.Format

func Decode

func Decode(reader io.Reader) (*sbom.SBOM, sbom.Format, error)

Decode takes a reader for an SBOM and generates all internal SBOM elements.

func Encode

func Encode(s sbom.SBOM, f sbom.Format) ([]byte, error)

Encode takes all SBOM elements and a format option and encodes an SBOM document.

func Formats

func Formats() []sbom.Format

func Identify

func Identify(by []byte) sbom.Format