cyclonedxutil

Documentation

Index

• Constants
• func SpecVersionFromString(v string) (cyclonedx.SpecVersion, error)
• func SupportedVersions(id sbom.FormatID) []string
• func VersionFromSpecVersion(spec cyclonedx.SpecVersion) string
• type Decoder
  • func NewDecoder(format cyclonedx.BOMFileFormat) Decoder
  • func (d Decoder) Decode(r io.Reader) (*cyclonedx.BOM, error)
• type Encoder
  • func NewEncoder(version string, format cyclonedx.BOMFileFormat, pretty bool) (Encoder, error)
  • func (e Encoder) Encode(writer io.Writer, s sbom.SBOM) error

Constants

const (
	XMLFormatID  sbom.FormatID = "cyclonedx-xml"
	JSONFormatID sbom.FormatID = "cyclonedx-json"
)

const DefaultVersion = "1.6"

Functions

func SpecVersionFromString

func SpecVersionFromString(v string) (cyclonedx.SpecVersion, error)

func SupportedVersions

func SupportedVersions(id sbom.FormatID) []string

func VersionFromSpecVersion

func VersionFromSpecVersion(spec cyclonedx.SpecVersion) string

Types

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

func NewDecoder

func NewDecoder(format cyclonedx.BOMFileFormat) Decoder

func (Decoder) Decode

func (d Decoder) Decode(r io.Reader) (*cyclonedx.BOM, error)

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

func NewEncoder

func NewEncoder(version string, format cyclonedx.BOMFileFormat, pretty bool) (Encoder, error)

func (Encoder) Encode

func (e Encoder) Encode(writer io.Writer, s sbom.SBOM) error